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

# Send a message

> Preferred send endpoint for custom HTTP and n8n. Respects the 24-hour session window;
use WhatsApp templates outside the window.




## OpenAPI

````yaml /openapi/integrations.json post /integrations/messages/send
openapi: 3.1.0
info:
  title: Vendschat Integration API
  version: '1.0'
  description: >
    Workspace API for Zapier, Make, n8n, and custom HTTP clients.

    Authenticate with a Growth+ integration API key. Keys only authorize
    `/v1/integrations/*`.
  contact:
    name: Vendschat
    url: https://vendschat.com
servers:
  - url: https://api.vendschat.com/v1
    description: Production
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Auth
    description: Verify API keys and workspace entitlements
  - name: Messages
    description: Channels, templates, and outbound sends
  - name: Contacts
    description: Lookup and manage contacts
  - name: Labels
    description: Workspace labels
  - name: Webhooks
    description: REST Hook subscribe lifecycle for Zapier, Make, and n8n
  - name: Platform helpers
    description: >-
      Dynamic form helpers for Zapier/Make connectors — prefer Messages send for
      custom HTTP
paths:
  /integrations/messages/send:
    post:
      tags:
        - Messages
      summary: Send a message
      description: >
        Preferred send endpoint for custom HTTP and n8n. Respects the 24-hour
        session window;

        use WhatsApp templates outside the window.
      operationId: sendIntegrationMessage
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendMessageRequest'
            examples:
              whatsappText:
                summary: WhatsApp text on a specific channel
                value:
                  identifier_type: phone_number
                  identifier_value: '+15551234567'
                  channel_mode: specific
                  channel_id: 15
                  message_type: text
                  text: Your BloomBox order is packed and ready.
              lastInteracted:
                summary: Last interacted channel
                value:
                  identifier_type: contact_id
                  identifier_value: '1001'
                  channel_mode: last_interacted
                  content_mode: text
                  text: Thanks for writing in — we are on it.
              whatsappTemplate:
                summary: WhatsApp template
                value:
                  identifier_type: phone_number
                  identifier_value: '+15551234567'
                  channel_mode: specific
                  channel_id: 15
                  message_type: template
                  template_id: 88
                  template_variables:
                    body_1: Alex
                    body_2: BB-2048
      responses:
        '200':
          description: Message accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendMessageResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    SendMessageRequest:
      type: object
      required:
        - identifier_type
        - identifier_value
        - channel_mode
      properties:
        identifier_type:
          type: string
          enum:
            - contact_id
            - email
            - phone_number
        identifier_value:
          type: string
        channel_mode:
          type: string
          enum:
            - last_interacted
            - specific
        channel_id:
          type: integer
          description: Required when channel_mode is specific
        content_mode:
          type: string
          enum:
            - text
            - attachment
          description: Used with last_interacted
        message_type:
          type: string
          description: Used with specific channel (text, template, image, …)
        text:
          type: string
        attachment_type:
          type: string
          enum:
            - image
            - video
            - audio
            - document
        media_url:
          type: string
          format: uri
        caption:
          type: string
        filename:
          type: string
        template_id:
          type: integer
        template_variables:
          type: object
          additionalProperties:
            type: string
          description: Keys from template form (`body_1`, `header_1`, …)
    SendMessageResponse:
      type: object
      properties:
        success:
          type: boolean
        thread_id:
          type: integer
        contact_id:
          type: integer
        channel_id:
          type: integer
        channel_type:
          type: string
        message_id:
          type: integer
        external_message_id:
          type: string
        status:
          type: string
        created_contact:
          type: boolean
        created_thread:
          type: boolean
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: '`Authorization: Bearer YOUR_API_KEY`'
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Alternative to Bearer auth

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.