> ## 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.

# Send an outbound message

> Operator-initiated outbound — the public sibling of the agent-only `send_whatsapp_message` tool. Around-the-brain workflows (n8n nurture loops, post-booking nudges) call this without going through the agent layer. Operator-curated copy is treated as authoritative; no hallucination grading or guardrail rewrites apply. The resulting message lands as `role=agent_bot` in the inbox transcript with a `source=public_api` tool_payload marker.



## OpenAPI

````yaml https://app.vorel.ai/api/v1/openapi.json post /api/v1/conversations/{id}/send
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/conversations/{id}/send:
    post:
      tags:
        - Conversations
      summary: Send an outbound message
      description: >-
        Operator-initiated outbound — the public sibling of the agent-only
        `send_whatsapp_message` tool. Around-the-brain workflows (n8n nurture
        loops, post-booking nudges) call this without going through the agent
        layer. Operator-curated copy is treated as authoritative; no
        hallucination grading or guardrail rewrites apply. The resulting message
        lands as `role=agent_bot` in the inbox transcript with a
        `source=public_api` tool_payload marker.
      operationId: sendConversationMessage
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: UUID of the conversation to send into.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConversationSendBody'
      responses:
        '200':
          description: Message persisted + queued for outbound delivery.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversationSendResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
      security:
        - BearerAuth:
            - conversations:write
components:
  schemas:
    ConversationSendBody:
      type: object
      required:
        - text
      description: >-
        Operator-initiated outbound copy. Treated as authoritative — no
        hallucination grading, no guardrail rewrites. Operators are accountable
        for the wording.
      properties:
        text:
          type: string
          minLength: 1
          maxLength: 4096
        language:
          type: string
          enum:
            - ar
            - en
            - mixed
    ConversationSendResponse:
      type: object
      required:
        - message_id
        - sequence_number
        - sent_at
        - mocked
      properties:
        message_id:
          type: string
          format: uuid
        sequence_number:
          type: integer
          minimum: 1
        sent_at:
          type: string
          format: date-time
        mocked:
          type: boolean
          description: >-
            True while the platform runs in MOCK_EXTERNAL mode (Phase 4a). Phase
            4b 360dialog integration flips this to false.
    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'
    NotFound:
      description: >-
        A referenced resource (e.g. `conversation_id` on a lead create, or any
        of the optional FK targets on an appointment create) is not visible to
        your tenant. Cross-tenant rows return the same envelope as
        truly-non-existent rows — this is intentional to prevent enumeration.
      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.

````