> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vorel.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create an offering

> Catalog entry — properties / services / treatments / etc. depending on your vertical pack. `attributes` carries vertical-specific keys. Does NOT emit a webhook event today (the canonical `WebhookEventName` union does not yet include `offering.*`).



## OpenAPI

````yaml https://app.vorel.ai/api/v1/openapi.json post /api/v1/offerings
openapi: 3.1.0
info:
  title: Vorel API
  version: 0.1.0
  description: >-
    Public API for Vorel — the AI receptionist for any business. Read your
    conversations, leads, appointments, and catalog; push CRM-side updates back
    into the platform. All endpoints accept bearer-auth API keys issued at
    `/settings/integrations/api-keys` in the dashboard. Per-key rate limit is
    200 req/min.
  contact:
    name: Vorel support
    email: hello@vorel.ai
  license:
    name: Proprietary
servers:
  - url: https://app.vorel.ai
    description: Production
  - url: http://localhost:3000
    description: Local dev
security:
  - BearerAuth: []
tags:
  - name: Conversations
    description: Inbound customer conversations across channels.
  - name: Leads
    description: Qualified-lead rows attached to conversations.
  - name: Appointments
    description: Scheduled customer engagements.
  - name: Offerings
    description: Tenant catalog (properties, services, treatments — vertical-specific).
  - name: Analytics
    description: >-
      Aggregate metrics for tenant + automation consumers. The around-the-brain
      workflows read these rather than mass-querying the resource endpoints.
  - name: CRM
    description: >-
      Operator-side writes into the tenant's configured CRM (HubSpot /
      Salesforce / Zoho / etc.). Per-tenant field mappings translate canonical
      Vorel keys to vendor-side keys before the driver call.
paths:
  /api/v1/offerings:
    post:
      tags:
        - Offerings
      summary: Create an offering
      description: >-
        Catalog entry — properties / services / treatments / etc. depending on
        your vertical pack. `attributes` carries vertical-specific keys. Does
        NOT emit a webhook event today (the canonical `WebhookEventName` union
        does not yet include `offering.*`).
      operationId: createOffering
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OfferingCreate'
      responses:
        '201':
          description: Offering created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Offering'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
      security:
        - BearerAuth:
            - offerings:write
components:
  schemas:
    OfferingCreate:
      type: object
      required:
        - title
        - price
      properties:
        external_id:
          type: string
          maxLength: 120
          nullable: true
        reference_number:
          type: string
          maxLength: 120
          nullable: true
        title:
          type: string
          minLength: 1
          maxLength: 500
        title_ar:
          type: string
          maxLength: 500
          nullable: true
        description:
          type: string
          maxLength: 10000
          nullable: true
        description_ar:
          type: string
          maxLength: 10000
          nullable: true
        attributes:
          type: object
          additionalProperties: true
        price:
          oneOf:
            - type: number
              minimum: 0
            - type: string
              pattern: ^[0-9]+(\.[0-9]+)?$
              description: Use string form for values that lose precision as JS numbers.
        price_currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: >-
            ISO 4217 (uppercase). Server defaults to the tenant's currency
            (derived from its country) if omitted.
        address:
          type: string
          maxLength: 500
          nullable: true
        photos:
          type: array
          items:
            type: string
            format: uri
            maxLength: 2048
          maxItems: 20
        status:
          type: string
          maxLength: 40
        available_from:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
          nullable: true
          description: YYYY-MM-DD; stored as date-only.
    Offering:
      type: object
      required:
        - id
        - title
        - price
        - price_currency
        - photos
        - status
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
        external_id:
          type: string
          nullable: true
        reference_number:
          type: string
          nullable: true
        title:
          type: string
        title_ar:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        description_ar:
          type: string
          nullable: true
        attributes:
          type: object
          additionalProperties: true
          description: >-
            Vertical-specific JSONB (real estate: `bedrooms`/`area`/etc.; salon:
            `service_type`/`duration_minutes`/etc.).
        price:
          type: string
          description: >-
            Decimal serialized as string to preserve precision for large values
            that lose accuracy as JS numbers. Caller can `parseFloat()` if they
            don't need the precision.
        price_currency:
          type: string
          minLength: 3
          maxLength: 3
          description: ISO 4217 (e.g. `AED`, `USD`).
        address:
          type: string
          nullable: true
        photos:
          type: array
          items:
            type: string
            format: uri
        status:
          type: string
        available_from:
          type: string
          format: date
          nullable: true
          description: YYYY-MM-DD, no time component.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ErrorEnvelope:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - unauthorized
                - forbidden
                - rate_limited
                - bad_request
                - not_found
                - conflict
                - internal_error
              description: Machine-readable error category.
            message:
              type: string
              description: >-
                Human-readable error description; safe to surface in tenant
                logs.
  responses:
    BadRequest:
      description: Body validation failed. Error message names the offending field.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Missing, malformed, unknown, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: >-
        API key is valid but lacks the required scope for this endpoint. Issue a
        new key with the necessary scope at `/settings/integrations/api-keys`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    RateLimited:
      description: >-
        200 req/min per API key exceeded. `Retry-After` header carries
        seconds-until-reset.
      headers:
        Retry-After:
          schema:
            type: integer
        X-RateLimit-Limit:
          schema:
            type: integer
        X-RateLimit-Remaining:
          schema:
            type: integer
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Unix epoch seconds.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: vapk_<env>_<48-hex>
      description: >-
        Tenant-issued API key. Format: `vapk_live_<48 hex chars>` (60 chars
        total). Issue + manage at `/settings/integrations/api-keys` in the Vorel
        dashboard. Each key has a scope set (`read`, `leads:write`,
        `appointments:write`, `offerings:write`); endpoints requiring a write
        scope reject keys without it with a 403 envelope.

````