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

# Start outbound batch

> Start or schedule a batch of outbound calls.



## OpenAPI

````yaml api-reference/calls/openapi.json POST /v1/calls/batch
openapi: 3.0.3
info:
  title: Persistence Calls API
  version: '1.0'
  description: Start outbound call batches and end active calls.
servers:
  - url: https://api.persistence.dev
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Calls
paths:
  /v1/calls/batch:
    post:
      tags:
        - Calls
      summary: Start outbound batch
      description: >-
        Start or schedule outbound calls for up to 1,000 recipients. The phone
        number's outbound agent is used unless agentId supplies a supported
        override.
      operationId: startOutboundBatch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchCallRequest'
      responses:
        '200':
          description: Batch accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchEnvelope'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    BatchCallRequest:
      type: object
      required:
        - callerId
        - recipients
      properties:
        callerId:
          type: string
          description: Phone number presented as caller ID.
        agentId:
          type: string
          description: >-
            Optional agent override. When omitted, the phone number's outbound
            agent is used.
        recipients:
          type: array
          minItems: 1
          maxItems: 1000
          items:
            $ref: '#/components/schemas/Recipient'
        maxConcurrency:
          type: integer
          description: Maximum calls processed concurrently.
        scheduledAt:
          type: string
          format: date-time
          nullable: true
        scheduleStart:
          $ref: '#/components/schemas/WindowTime'
        scheduleEnd:
          $ref: '#/components/schemas/WindowTime'
        timezone:
          type: string
          description: IANA time zone used for the schedule.
    BatchEnvelope:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/BatchCallResponse'
    Recipient:
      type: object
      required:
        - phoneNumber
      properties:
        phoneNumber:
          type: string
        metadata:
          type: object
          additionalProperties:
            type: string
        reason:
          type: string
          description: Rejection reason when returned in rejectedRecipients.
    WindowTime:
      type: string
      pattern: ^(?:[01][0-9]|2[0-3]):[0-5][0-9]$
      example: '09:30'
      description: Zero-padded HH:MM time in the selected timezone.
    BatchCallResponse:
      type: object
      required:
        - status
        - acceptedRecipients
        - rejectedRecipients
      properties:
        batchCallId:
          type: string
        status:
          type: string
        acceptedRecipients:
          type: integer
        rejectedRecipients:
          type: array
          items:
            $ref: '#/components/schemas/Recipient'
    Error:
      type: object
      properties:
        code:
          type: string
        error:
          type: string
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key issued for the workspace.

````