Pause a Campaign

POST https://api.ocamba.com/v1/hood/campaigns/{id}/pause

Temporarily suspends a running campaign. Pausing a campaign stops all associated actions (such as sending messages, serving ads, etc.) without deleting campaign data.

Warning

This change will be automatically synchronized.

Note

Only campaigns in status ‘ready_to_launch’ or ‘scheduled’ can be paused.

Tip

If you don’t know the campaign’s id, list the campaigns to find it.

Rate limits:

Burst: 10/s
Steady: 150/m

Path parameters

parameters

Request schema

body

Response schemas

•

204

No Content

›

400

application/json

›

500

application/json

curl -X POST \
 "https://api.ocamba.com/v1/hood/campaigns/{id}/pause" \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "Pausing reason"
}'

const url = 'https://api.ocamba.com/v1/hood/campaigns/{id}/pause';
const options = {
  method: 'POST',
  headers: {
    Authorization: "Bearer {TOKEN}",
    'Content-Type': "application/json"
  },
  body: JSON.stringify(
    {
      "reason": "Pausing reason"
    }
  )
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

$ch = curl_init("https://api.ocamba.com/v1/hood/campaigns/{id}/pause");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer {TOKEN}",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(
  [
    "reason" => "Pausing reason"
  ]
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Responses

204 No Content

400 Bad Request

{
  "code": 400,
  "title": "Bad request.",
  "message": "The request is not valid.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}

500 Internal Server Error

{
  "code": 500,
  "title": "Internal server error.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}

Responses

LinkedIn Facebook Instagram