Cancel a Campaign

Cancel a Campaign

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

Terminates a campaign permanently. Once canceled, the campaign cannot be resumed or reactivated.

Rate limits:

Burst: 10/s
Steady: 150/m

Path parameters

parameters

Request schema

body

Response schemas

POST https://api.ocamba.com/v1/hood/campaigns/{id}/cancel HTTP/1.1
Host: api.ocamba.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
{
  "reason": "Cancelation reason"
}
curl -X POST "https://api.ocamba.com/v1/hood/campaigns/{id}/cancel" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Cancelation reason"}'
fetch("https://api.ocamba.com/v1/hood/campaigns/{id}/cancel", {
  method: "POST",
  headers: { Authorization: `Bearer ${TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify(
    {
      "reason": "Cancelation reason"
    }
  )
}).then(r => r.json());
$ch = curl_init("https://api.ocamba.com/v1/hood/campaigns/{id}/cancel");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer $token",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(
  [
    "reason" => "Cancelation reason"
  ]
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Responses

204 No Content

HTTP/1.1 204 No Content
Content-Type: application/json

400 Bad Request

HTTP/1.1 400 Bad Request
Content-Type: application/json

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

500 Internal Server Error

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

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

Warning
1
This change will be automatically synchronized.
Note
1
We recommend you consider other options before cancelation.
2
Only campaign in status ‘running’, ‘scheduled’ or ‘paused’ can be canceled.
Tip
1
If you don’t know the campaign’s id, list the campaigns to find it.