Edit a Campaign
Edit a Campaign
PATCH
https://api.ocamba.com/v1/hood/campaigns/{id}
Update of a campaign using the HTTP PATCH. Only the fields that need to be updated should be included in the request body. Fields that are omitted will remain unchanged. Any included fields with different values from the existing ones will be updated accordingly. This endpoint supports JSON Merge Patch as defined in RFC 7386.
Rate limits:
Burst: 10/s
Steady: 150/m
Path parameters
parametersRequest schema
bodyResponse schemas
›
400
application/json
›
500
application/json
PATCH https://api.ocamba.com/v1/hood/campaigns/{id} HTTP/1.1
Host: api.ocamba.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
{
"description": "This is my first campaign on the Hood application.",
"labels": [
"cars",
"bwm",
"audi",
"volkswagen"
],
"metadata": {},
"ab_test": {},
"recurrence": {},
"utm_tracking": {},
"send_in_profile_time_zone": true,
"send_if_profile_time_passed": true,
"quiet_hours": {},
"targeting": {},
"deal_id": "1000251",
"run_immediately": null
}
curl -X PATCH "https://api.ocamba.com/v1/hood/campaigns/{id}" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"description":"This is my first campaign on the Hood application.","labels":["cars","bwm","audi","volkswagen"],"metadata":{},"ab_test":{},"recurrence":{},"utm_tracking":{},"send_in_profile_time_zone":true,"send_if_profile_time_passed":true,"quiet_hours":{},"targeting":{},"deal_id":"1000251","run_immediately":null}'
fetch("https://api.ocamba.com/v1/hood/campaigns/{id}", {
method: "PATCH",
headers: { Authorization: `Bearer ${TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify(
{
"description": "This is my first campaign on the Hood application.",
"labels": [
"cars",
"bwm",
"audi",
"volkswagen"
],
"metadata": {},
"ab_test": {},
"recurrence": {},
"utm_tracking": {},
"send_in_profile_time_zone": true,
"send_if_profile_time_passed": true,
"quiet_hours": {},
"targeting": {},
"deal_id": "1000251",
"run_immediately": null
}
)
}).then(r => r.json());
$ch = curl_init("https://api.ocamba.com/v1/hood/campaigns/{id}");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer $token",
"Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(
[
"description" => "This is my first campaign on the Hood application.",
"labels" => [
"cars",
"bwm",
"audi",
"volkswagen"
],
"metadata" => [],
"ab_test" => [],
"recurrence" => [],
"utm_tracking" => [],
"send_in_profile_time_zone" => true,
"send_if_profile_time_passed" => true,
"quiet_hours" => [],
"targeting" => [],
"deal_id" => "1000251",
"run_immediately" => null
]
));
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
Tip
1
If you don’t know the campaign id, list the campaigns to find it.
Note
1
Campaigns that are in running, canceled, sent, or waiting_for_decision status cannot be updated. Any attempt to update a campaign in one of these statuses will be rejected.
Warning
1
The status can only be changed from draft to any other status. No other status can be changed into draft.
2
If you pass the run_immediately field as true, the campaign will execute right away on it’s creation.