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

# Send a Quick iMessage

> Sends one iMessage to one person (E.164 phone number or Apple ID email) from a shared LumisReach iMessage line, so no Apple device or line has to be owned. One-way: replies are not delivered back to the API yet. Apple filters unsolicited blue bubbles hard, so: a first message to someone the line has never messaged cannot contain a link (400), the shared line opens a limited number of new conversations per day across all customers (409 when spent), each workspace may send 20 per rolling 24 hours (409), and numbers on the workspace's opt-out list are refused (403). Returns 409 while iMessage is not enabled on the deployment. Billing: $0.10 per message sent, charged to the wallet of the organization that owns the API key.



## OpenAPI

````yaml /openapi.json post /v1/quick/imessages
openapi: 3.1.0
info:
  title: LumisReach v1 API
  version: 1.0.0
  description: >-
    Programmatic access to the LumisReach voice platform — calls, numbers,
    caller trust, and brands.
  contact:
    name: LumisReach
    email: founders@lumisreach.com
servers:
  - url: https://api.lumisreach.com/api
security:
  - bearerAuth: []
tags:
  - name: Contacts
  - name: Calls
  - name: Messages
  - name: Emails
  - name: Phone Numbers
  - name: Caller IDs
  - name: Enterprise Registration
  - name: Branded Calling
  - name: Dialer Calls
  - name: SMS
  - name: WebRTC
  - name: Reputation
  - name: Usage
  - name: Account
  - name: Billing
  - name: Documents
  - name: Lincoln AI
  - name: Quick Agent Actions
  - name: Sub-entities
  - name: Video schedules
  - name: Videos
paths:
  /v1/quick/imessages:
    post:
      tags:
        - Quick Agent Actions
      summary: Send a Quick iMessage
      description: >-
        Sends one iMessage to one person (E.164 phone number or Apple ID email)
        from a shared LumisReach iMessage line, so no Apple device or line has
        to be owned. One-way: replies are not delivered back to the API yet.
        Apple filters unsolicited blue bubbles hard, so: a first message to
        someone the line has never messaged cannot contain a link (400), the
        shared line opens a limited number of new conversations per day across
        all customers (409 when spent), each workspace may send 20 per rolling
        24 hours (409), and numbers on the workspace's opt-out list are refused
        (403). Returns 409 while iMessage is not enabled on the deployment.
        Billing: $0.10 per message sent, charged to the wallet of the
        organization that owns the API key.
      operationId: v1_quick_imessages_post
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            A UUID. When present, deduplicates repeat submissions. See
            /api-reference/idempotency.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: http://json-schema.org/draft-07/schema#
              type: object
              properties:
                to:
                  type: string
                  maxLength: 254
                  pattern: >-
                    ^(\+[1-9]\d{1,14}|[^\s@<>(),;:"]+@[^\s@<>(),;:"]+\.[a-zA-Z]{2,})$
                  description: >-
                    Recipient: E.164 phone (+14155550123) or the email address
                    of their Apple ID
                text:
                  type: string
                  minLength: 1
                  maxLength: 2000
              required:
                - to
                - text
              additionalProperties: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: http://json-schema.org/draft-07/schema#
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        pattern: >-
                          ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                      kind:
                        type: string
                        const: imessage
                      status:
                        type: string
                        const: sent
                      to:
                        type: string
                      from:
                        type: string
                      cost_usd:
                        type: number
                      pricing:
                        type: object
                        properties:
                          per_message_usd:
                            type: number
                          note:
                            type: string
                        required:
                          - per_message_usd
                          - note
                        additionalProperties: false
                    required:
                      - id
                      - kind
                      - status
                      - to
                      - from
                      - cost_usd
                      - pricing
                    additionalProperties: false
                required:
                  - data
                additionalProperties: false
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '409':
          description: Conflict (incl. idempotency conflicts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
components:
  schemas:
    ErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            fields:
              type: object
              additionalProperties:
                type: string
            doc_url:
              type: string
              format: uri
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````