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

# Send a customer message



## OpenAPI

````yaml /api-reference/support-openapi.json post /api/integration/ai_service/customer/send
openapi: 3.1.0
info:
  title: Clarity Support API
  version: '1.0'
  description: Tickets, customers, messages, the knowledge base, and webhooks.
servers:
  - url: https://back.leap.onclarity.com
security:
  - organizationApiKey: []
tags:
  - name: AI service
    description: >-
      Hand a customer conversation to your Clarity AI agent from your own app or
      backend.
  - name: Messages
    description: Reply to customers on their ticket's channel and add private notes.
  - name: Customers
    description: Create, update, and look up customers and their custom attributes.
  - name: Tickets
    description: >-
      Change a ticket's status, assignee, category, and tags, and list the
      values they take.
  - name: Knowledge base
    description: Manage the articles your AI agents answer from.
  - name: Webhooks
    description: Subscribe your endpoints to events in your organization.
paths:
  /api/integration/ai_service/customer/send:
    post:
      tags:
        - AI service
      summary: Send a customer message
      operationId: ApiIntegrationAiServiceCustomerSendSendCustomerMessage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendCustomerMessageRequest'
        required: true
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/message_schema_SendMessageResponse'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KTSErrorResponse'
        '500':
          description: Server got itself in trouble
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KTSErrorResponse'
      deprecated: false
components:
  schemas:
    SendCustomerMessageRequest:
      properties:
        customer_id:
          type: integer
        ticket_id:
          type: integer
        text:
          type: string
        files:
          items:
            type: integer
          type: array
          default: []
        ai_chat:
          type: boolean
          default: false
        message_type:
          oneOf:
            - $ref: '#/components/schemas/AISimulationMessageType'
            - type: 'null'
        trigger_internal_id:
          oneOf:
            - type: string
            - type: 'null'
        suggested_actions:
          oneOf:
            - items:
                additionalProperties: {}
                type: object
              type: array
            - type: 'null'
        state:
          oneOf:
            - type: string
            - type: 'null'
      type: object
      required:
        - customer_id
        - text
        - ticket_id
      title: SendCustomerMessageRequest
    message_schema_SendMessageResponse:
      properties:
        created_at:
          type: string
          format: date-time
        internal_id:
          type: string
        files:
          items:
            $ref: '#/components/schemas/AttachmentFileResponse'
          type: array
      type: object
      required:
        - created_at
        - internal_id
      title: SendMessageResponse
    KTSErrorResponse:
      properties:
        status:
          type: string
          default: error
        code:
          type: string
        message:
          oneOf:
            - type: string
            - type: 'null'
        extra:
          oneOf:
            - additionalProperties: {}
              type: object
            - items: {}
              type: array
            - type: 'null'
      type: object
      required:
        - code
      title: KTSErrorResponse
    AISimulationMessageType:
      type: string
      enum:
        - prompt
        - recommendation
      title: AISimulationMessageType
    AttachmentFileResponse:
      properties:
        id:
          type: integer
        original_url:
          type: string
        thumbnail_url:
          oneOf:
            - type: string
            - type: 'null'
        mime_type:
          type: string
        original_filename:
          type: string
      type: object
      required:
        - id
        - mime_type
        - original_filename
        - original_url
      title: AttachmentFileResponse
  securitySchemes:
    organizationApiKey:
      type: http
      scheme: bearer
      description: >-
        Your organization API key (it starts with `anek_org_`). The same key
        works on the Voice API and the Support API. See
        [Authentication](/authentication).

````

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