> ## Documentation Index > Fetch the complete documentation index at: https://docs.truedy.ai/llms.txt > Use this file to discover all available pages before exploring further. # Pause Batch Call > Pause an active or scheduled batch call. No request body is required. ## OpenAPI ````yaml /api-reference/openapi.json post /batch-calls/{batch_call_id}/pause openapi: 3.1.0 info: title: Truedy API description: >- Truedy Public API. Authenticate with **Authorization: Bearer <your-api-key>** only. Get your API key from the [Truedy Dashboard](https://app.truedy.ai). Base URL: https://api.truedy.ai/api/public/v1 version: 1.0.0 servers: - url: https://api.truedy.ai/api/public/v1 description: Production security: - bearerAuth: [] tags: - name: Agents description: Create, configure, test, retrieve, and delete voice agents. - name: Calls description: >- Create and manage outbound calls, recordings, transcripts, and call metadata. - name: Tools description: Create and manage agent tools. - name: Knowledge Bases description: Legacy Ultravox-backed knowledge bases and sources. - name: Knowledge Spaces description: >- Truedy-native RAG knowledge spaces, sources, ingestion jobs, and retrieval. - name: Voices description: Browse, import, clone, synchronize, preview, and delete voices. - name: Telephony description: Search, purchase, import, assign, unassign, and release phone numbers. - name: Batch Calls description: Create and manage outbound batch calling campaigns and their contacts. - name: Contacts description: Manage contact folders, contacts, imports, and exports. - name: Calls description: Start browser-based Web Calls with an active agent. - name: Widgets description: Manage New Frontend widget configurations and embed sessions. - name: Agent Templates description: Read active agent templates available to the organization. - name: Call Explainability description: Retrieve redacted structured evidence for a call. - name: Webhooks description: Manage organization webhook endpoints and delivery history. - name: Analytics description: Read organization dashboard and conversation intelligence analytics. - name: Exports description: Export organization calls and campaigns as CSV. - name: Workspaces description: Create and manage workspaces with an account-scoped master API key. paths: /batch-calls/{batch_call_id}/pause: post: tags: - Batch Calls summary: Pause Batch Call description: Pause an active or scheduled batch call. No request body is required. operationId: pause_batch_call_api_public_v1_batch_calls__batch_call_id__pause_post parameters: - name: batch_call_id in: path required: true schema: type: string title: Batch Call Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PublicBatchSingleResponse' '401': $ref: '#/components/responses/PublicUnauthorized' '403': $ref: '#/components/responses/PublicForbidden' '422': $ref: '#/components/responses/PublicValidationError' '429': $ref: '#/components/responses/PublicRateLimitExceeded' '500': $ref: '#/components/responses/PublicInternalError' security: - bearerAuth: [] components: schemas: PublicBatchSingleResponse: properties: data: $ref: '#/components/schemas/PublicBatchResource' meta: $ref: '#/components/schemas/ResponseMeta' type: object required: - data - meta title: PublicBatchSingleResponse PublicBatchResource: properties: id: type: string title: Id clerk_org_id: anyOf: - type: string - type: 'null' title: Clerk Org Id name: type: string title: Name agent_id: type: string title: Agent Id phone_number_ids: items: type: string type: array title: Phone Number Ids phone_rotation_strategy: type: string title: Phone Rotation Strategy contact_source: type: string title: Contact Source contact_folder_id: anyOf: - type: string - type: 'null' title: Contact Folder Id status: type: string title: Status schedule_type: type: string title: Schedule Type scheduled_at: anyOf: - type: string format: date-time - type: 'null' title: Scheduled At timezone: type: string title: Timezone start_time: anyOf: - type: string - type: 'null' title: Start Time end_time: anyOf: - type: string - type: 'null' title: End Time working_days: items: type: integer type: array title: Working Days max_concurrent_calls: type: integer title: Max Concurrent Calls max_calls_per_day: anyOf: - type: integer - type: 'null' title: Max Calls Per Day retry_failed: type: boolean title: Retry Failed max_retry_attempts: type: integer title: Max Retry Attempts total_contacts: type: integer title: Total Contacts completed_contacts: type: integer title: Completed Contacts successful_contacts: type: integer title: Successful Contacts failed_contacts: type: integer title: Failed Contacts voicemail_contacts: type: integer title: Voicemail Contacts no_answer_contacts: type: integer title: No Answer Contacts total_cost_usd: type: number title: Total Cost Usd average_duration_seconds: type: integer title: Average Duration Seconds created_at: type: string format: date-time title: Created At updated_at: anyOf: - type: string format: date-time - type: 'null' title: Updated At type: object required: - id - name - agent_id - phone_rotation_strategy - contact_source - status - schedule_type - timezone - max_concurrent_calls - retry_failed - max_retry_attempts - total_contacts - completed_contacts - successful_contacts - failed_contacts - voicemail_contacts - no_answer_contacts - total_cost_usd - average_duration_seconds - created_at title: PublicBatchResource ResponseMeta: properties: request_id: type: string title: Request Id description: Unique request identifier for support and debugging ts: type: string format: date-time title: Ts description: Server timestamp when the response was generated type: object required: - request_id - ts title: ResponseMeta description: Metadata included in every API response. PublicApiErrorResponse: type: object required: - error - meta properties: error: type: object required: - code - message properties: code: type: string description: Stable machine-readable error code. message: type: string description: Human-readable explanation. details: description: >- Structured, endpoint-specific details. Never rely on undocumented provider fields. type: - object - array - 'null' meta: $ref: '#/components/schemas/ResponseMeta' description: Request correlation metadata. example: error: code: validation_error message: 'Missing required field: name' details: errors: [] meta: request_id: req_01JEXAMPLE ts: '2026-08-21T00:00:00Z' responses: PublicUnauthorized: description: Missing, malformed, expired, inactive, or invalid API key. content: application/json: schema: $ref: '#/components/schemas/PublicApiErrorResponse' PublicForbidden: description: >- The API key is valid but the request is not permitted by its organization, IP allowlist, or scope. content: application/json: schema: $ref: '#/components/schemas/PublicApiErrorResponse' PublicValidationError: description: The request is syntactically valid but fails endpoint validation. content: application/json: schema: $ref: '#/components/schemas/PublicApiErrorResponse' PublicRateLimitExceeded: description: >- The API key or organization exceeded a configured request limit. Retry after the response headers/window indicate. content: application/json: schema: $ref: '#/components/schemas/PublicApiErrorResponse' headers: Retry-After: schema: type: integer minimum: 0 description: Seconds until retry is permitted, when available. X-RateLimit-Limit: schema: type: integer description: Configured request limit. X-RateLimit-Remaining: schema: type: integer minimum: 0 description: Remaining requests in the current window. X-RateLimit-Reset: schema: type: string format: date-time description: UTC time at which the current window resets. PublicInternalError: description: Unexpected server failure. Use meta.request_id when contacting support. content: application/json: schema: $ref: '#/components/schemas/PublicApiErrorResponse' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: 'Your API key. Send in the Authorization header as: Bearer ' ````