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

# Automations - Trigger

> Trigger an active API automation for a list of contacts. Only the first 50 contacts of a request are processed. Contacts that don't exist yet in Simio are created, and their variables are saved for message personalization. Automation sends bypass delivery-hours and opt-out checks. The send is queued and processed in the background. Rate limit: 20 requests per second.



## OpenAPI

````yaml post /api/automations/send
openapi: 3.1.0
info:
  title: Simio API - automations
  version: 2.0.0
servers:
  - url: https://getsimio.app
security: []
paths:
  /api/automations/send:
    post:
      tags:
        - automations-trigger
      summary: Automations - Trigger
      description: >-
        Trigger an active API automation for a list of contacts. Only the first
        50 contacts of a request are processed. Contacts that don't exist yet in
        Simio are created, and their variables are saved for message
        personalization. Automation sends bypass delivery-hours and opt-out
        checks. The send is queued and processed in the background. Rate limit:
        20 requests per second.
      operationId: trigger_automation_api_automations_send_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutomationTriggerRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendAcceptedResponse'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Missing or invalid `simio-api-key`.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Your company has no active subscription.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Automation not found or not active.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Invalid request, missing trigger variables, no WhatsApp template
            selected, or no connected WhatsApp account assigned.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitResponse'
          description: Rate limit exceeded.
      security:
        - SimioApiKey: []
components:
  schemas:
    AutomationTriggerRequest:
      properties:
        automation_id:
          description: ID of the 'api'-type automation to trigger.
          examples:
            - 123
          title: Automation Id
          type: integer
        contacts:
          description: >-
            Contacts to send to. Up to 1000 are accepted, but only the first 50
            per request are processed - split larger batches across multiple
            calls.
          items:
            $ref: '#/components/schemas/AutomationTriggerContact'
          title: Contacts
          type: array
        image_url:
          anyOf:
            - maxLength: 2048
              pattern: ^https?://\S+$
              type: string
            - type: 'null'
          description: Image URL applied to all contacts unless overridden per-contact.
          examples:
            - https://example.com/offer.png
          title: Image Url
        url:
          anyOf:
            - maxLength: 2048
              pattern: ^https?://\S+$
              type: string
            - type: 'null'
          description: Override for the template's first URL button destination.
          examples:
            - https://example.com/track/abc123
          title: Url
        url2:
          anyOf:
            - maxLength: 2048
              pattern: ^https?://\S+$
              type: string
            - type: 'null'
          description: Override for the template's second URL button destination.
          examples:
            - https://example.com/track/def456
          title: Url2
        video_url:
          anyOf:
            - maxLength: 2048
              pattern: ^https?://\S+$
              type: string
            - type: 'null'
          description: Video URL applied to all contacts unless overridden per-contact.
          examples:
            - https://example.com/offer.mp4
          title: Video Url
      required:
        - automation_id
        - contacts
      title: AutomationTriggerRequest
      type: object
    SendAcceptedResponse:
      properties:
        batch_id:
          description: Identifier of this send batch.
          examples:
            - '1759842000000'
          title: Batch Id
          type: string
        contacts:
          description: Number of contacts the send was queued for.
          examples:
            - 2
          title: Contacts
          type: integer
        status:
          const: accepted
          description: >-
            Always `accepted`: the send is queued and processed in the
            background.
          examples:
            - accepted
          title: Status
          type: string
      required:
        - status
        - batch_id
        - contacts
      title: SendAcceptedResponse
      type: object
    ErrorResponse:
      properties:
        detail:
          description: Human-readable error message.
          examples:
            - Invalid API key
          title: Detail
          type: string
      required:
        - detail
      title: ErrorResponse
      type: object
    RateLimitResponse:
      properties:
        error:
          description: Rate limit that was exceeded.
          examples:
            - 'Rate limit exceeded: 10 per 1 second'
          title: Error
          type: string
      required:
        - error
      title: RateLimitResponse
      type: object
    AutomationTriggerContact:
      properties:
        first_name:
          anyOf:
            - maxLength: 255
              type: string
            - type: 'null'
          description: Contact's first name, available for message personalization.
          examples:
            - Firstname
          title: First Name
        image_url:
          anyOf:
            - maxLength: 2048
              pattern: ^https?://\S+$
              type: string
            - type: 'null'
          description: Per-contact override for the message's image URL.
          examples:
            - https://example.com/offer.png
          title: Image Url
        last_name:
          anyOf:
            - maxLength: 255
              type: string
            - type: 'null'
          description: Contact's last name, available for message personalization.
          examples:
            - Lastname
          title: Last Name
        phone:
          description: Contact's phone number in E.164 format (digits only).
          examples:
            - '33612345678'
          pattern: ^\+?[1-9]\d{6,14}$
          title: Phone
          type: string
        variables:
          additionalProperties:
            maxLength: 4096
            type: string
          description: >-
            Values for the automation's declared trigger variables, keyed by
            variable name. Required for every variable declared on the
            automation's scenario.
          examples:
            - discount_code: SUMMER10
          propertyNames:
            maxLength: 100
          title: Variables
          type: object
        video_url:
          anyOf:
            - maxLength: 2048
              pattern: ^https?://\S+$
              type: string
            - type: 'null'
          description: Per-contact override for the message's video URL.
          examples:
            - https://example.com/offer.mp4
          title: Video Url
      required:
        - phone
      title: AutomationTriggerContact
      type: object
  securitySchemes:
    SimioApiKey:
      description: >-
        Company API key, created in Settings > Integrations & developers >
        Credentials.
      in: header
      name: simio-api-key
      type: apiKey

````

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