Skip to main content
Pause Campaign
curl --request PATCH \
  --url https://api.agents.timepay.ai/api/v1/campaigns/pause/{id} \
  --header 'Authorization: <authorization>'
{
  "success": true,
  "message": "Campaign paused successfully",
  "data": {
    "id": "camp_abc123",
    "status": "paused",
    "pausedAt": "2025-01-02T10:30:00Z"
  }
}

​
Headers

​
Authorization
string
required
Bearer token for authentication (e.g., Bearer <your_token>).

​
Path Parameters

​
id
string
required
The unique identifier of the campaign to pause (e.g., camp_abc123).

​
Response

​
success
boolean
Indicates if the action was successful.
​
message
string
A confirmation message.
​
data
object
Updated campaign details.
​
error
string
The error type or code (Error responses only).
{
  "success": true,
  "message": "Campaign paused successfully",
  "data": {
    "id": "camp_abc123",
    "status": "paused",
    "pausedAt": "2025-01-02T10:30:00Z"
  }
}