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

# Batch - Send campaign

> Send a Simio campaign to a list of contacts from Batch. Requires the Batch connector to be connected in Simio. The send is queued and processed in the background. Rate limit: 1 request every 10 seconds.



## OpenAPI

````yaml post /api/batch/send
openapi: 3.1.0
info:
  title: Simio API - batch
  version: 2.0.0
servers:
  - url: https://getsimio.app
security: []
paths:
  /api/batch/send:
    post:
      tags:
        - batch
      summary: Batch - Send campaign
      description: >-
        Send a Simio campaign to a list of contacts from Batch. Requires the
        Batch connector to be connected in Simio. The send is queued and
        processed in the background. Rate limit: 1 request every 10 seconds.
      operationId: send_campaign_api_batch_send_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchSendRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorSendResponse'
          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: Campaign not found, or the Batch connector is not connected.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitResponse'
          description: Rate limit exceeded.
      security:
        - SimioApiKey: []
components:
  schemas:
    BatchSendRequest:
      properties:
        campaign_id:
          description: ID of the Simio campaign to send.
          examples:
            - 123
          minimum: 1
          title: Campaign Id
          type: integer
        contacts:
          description: Recipients of the campaign (1 to 1000 per request).
          examples:
            - - phone: '+33612345678'
          items:
            $ref: '#/components/schemas/BatchContact'
          maxItems: 1000
          minItems: 1
          title: Contacts
          type: array
      required:
        - campaign_id
        - contacts
      title: BatchSendRequest
      type: object
    ConnectorSendResponse:
      properties:
        message:
          description: Human-readable confirmation.
          examples:
            - Campaign send enqueued
          title: Message
          type: string
        status:
          const: accepted
          description: >-
            Always `accepted`: the send is queued and processed in the
            background.
          examples:
            - accepted
          title: Status
          type: string
      required:
        - status
        - message
      title: ConnectorSendResponse
      type: object
    ErrorResponse:
      properties:
        detail:
          description: Human-readable error message.
          examples:
            - Invalid API key
          title: Detail
          type: string
      required:
        - detail
      title: ErrorResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      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
    BatchContact:
      properties:
        phone:
          description: Recipient phone number in E.164 format.
          examples:
            - '+33612345678'
          maxLength: 32
          minLength: 1
          title: Phone
          type: string
      required:
        - phone
      title: BatchContact
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      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.