---
title: "Pause campaign"
method: POST
path: "/campaigns/{id}/pause"
tags: ["Campaigns"]
---

# Pause campaign

`POST /campaigns/{id}/pause`

## Request

- Base URL: `https://api.textla.com/v1`
- URL: `https://api.textla.com/v1/campaigns/{id}/pause`
- Auth: HTTP bearer

Pauses a campaign; the only way to stop a scheduled campaign from firing. Resume undoes it, except within 5 minutes of the send time. Pausing a send already in progress also works, but only for accounts with the send-controls flag — for the rest the operation is 409. It is also 409 when the campaign cannot be paused in its current state, or is an Immediate one-time campaign that has not started sending, and 404 when the account has no campaign with the ID.

## Path parameters

- `id` string, required

## Response `200`

OK

- Campaign
  - `$schema` string, uri: A URL to the JSON Schema for this object.
  - `audience` AudienceFilter, required
    - `all_contacts` boolean, nullable, required
    - `groups` LabelFilter, required
      - `exclude` string[], nullable, required
      - `include` string[], nullable, required
      - `match` string, nullable, required
    - `keywords` LabelFilter, required
      - `exclude` string[], nullable, required
      - `include` string[], nullable, required
      - `match` string, nullable, required
    - `tags` LabelFilter, required
      - `exclude` string[], nullable, required
      - `include` string[], nullable, required
      - `match` string, nullable, required
  - `batch_count` integer, required
  - `created_at` integer, required
  - `current_batch` CurrentBatch, required
    - `id` string, required
    - `status` string, required
  - `failure_code` string, nullable, required
  - `id` string, required
  - `media` Media[], nullable, required
    - `content_type` string, required
    - `height` integer, nullable, required
    - `id` string, required
    - `name` string, required
    - `size_bytes` integer, required
    - `url` string, nullable, required
    - `width` integer, nullable, required
  - `message` string, required
  - `message_count` integer, required
  - `name` string, required
  - `phone_number` string, required
  - `rejection_reason` string, nullable, required
  - `send_at` integer, nullable, required
  - `status` string, required
  - `updated_at` integer, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `412`: Precondition Failed
- `422`: Unprocessable Entity
- `429`: Too Many Requests
- `500`: Internal Server Error
- `501`: Not Implemented
- `502`: Bad Gateway
- `503`: Service Unavailable
- `504`: Gateway Timeout

---

[API](https://skmtc.dev/textla/apis/textla-api.md) - [All operations](https://skmtc.dev/textla/apis/textla-api/llms.txt) - [OpenAPI document](https://skmtc.dev/textla/apis/textla-api/revisions/473f03350bc1?raw)