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

# Schedule a campaign

> Queues dialing at startTime in the given IANA timezone, and pauses until the next day's startTime after endTime. A paused or stopped campaign resumes from its saved contact index.



## OpenAPI

````yaml /openapi.json post /public/v1/campaigns/{campaignId}/schedule
openapi: 3.0.3
info:
  title: Callin Public API
  version: 1.0.0
  description: >-
    The Callin public API lets you programmatically build and manage AI voice
    agents, control their knowledge bases, and retrieve call logs and
    transcripts. All endpoints are versioned under /public/v1.
servers:
  - url: https://api.callin.io/api
    description: API Endpoint
security: []
tags:
  - name: Health
    description: Service availability check. No authentication required.
  - name: Identity
    description: Verify which account is associated with the current API key.
  - name: Agents
    description: Create, retrieve, and update AI voice agents.
  - name: Conversations
    description: List and inspect call logs, transcripts, and conversation details.
  - name: Knowledge Base
    description: Manage documents and groups that agents use during calls.
  - name: Campaigns
    description: ...
  - name: Contacts
    description: ...
paths:
  /public/v1/campaigns/{campaignId}/schedule:
    post:
      tags:
        - Campaigns
      summary: Schedule a campaign
      description: >-
        Queues dialing at startTime in the given IANA timezone, and pauses until
        the next day's startTime after endTime. A paused or stopped campaign
        resumes from its saved contact index.
      parameters:
        - name: campaignId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleCampaignRequest'
      responses:
        '200':
          description: Campaign scheduled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessCampaignResponse'
      security:
        - ApiKeyHeader: []
        - BearerAuth: []
        - ApiKeyQuery: []
components:
  schemas:
    ScheduleCampaignRequest:
      type: object
      properties:
        startTime:
          type: string
        endTime:
          type: string
        timezone:
          type: string
    SuccessCampaignResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Campaign'
        warning:
          type: string
        requestId:
          type: string
          nullable: true
    Campaign:
      type: object
      properties:
        campaignId:
          type: string
        name:
          type: string
        agentId:
          type: string
        active:
          type: boolean
        scheduled:
          type: boolean
        startTime:
          type: string
          nullable: true
        endTime:
          type: string
          nullable: true
        timezone:
          type: string
          nullable: true
        status:
          type: string
        startIndex:
          type: integer
        contactCount:
          type: integer
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/CampaignContact'
        followUp:
          type: object
          properties:
            enabled:
              type: boolean
            attempts:
              type: integer
            intervalsMinutes:
              type: array
              items:
                type: integer
        metadata:
          type: object
          properties:
            createdAt:
              type: string
              nullable: true
            updatedAt:
              type: string
              nullable: true
            deletedAt:
              type: string
              nullable: true
    CampaignContact:
      type: object
      required:
        - phoneNumber
      properties:
        contactId:
          type: string
          nullable: true
        phoneNumber:
          type: string
        name:
          type: string
        email:
          type: string
      additionalProperties: true
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: Send your Callin API key in the `x-api-key` header.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Same API key as a Bearer token: `Authorization: Bearer <your-api-key>`.'

````

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