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.

Tip

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

Note

Campaigns that are in running, canceled, sent, or needs_decision status cannot be updated. Any attempt to update a campaign in one of these statuses will be rejected.

Warning

The status can only be changed from draft to any other status. No other status can be changed into draft. If you pass the run_immediately field as true, the campaign will execute right away on it’s creation.

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 PATCH \
 "https://api.ocamba.com/v1/hood/campaigns/{id}" \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "My First Campaign",
  "description": "This is my first campaign on the Hood application.",
  "labels": [
    "cars",
    "bwm",
    "audi",
    "volkswagen"
  ],
  "metadata": {},
  "scheduled_time": "2024-10-06 10:00:00",
  "ab_test": {},
  "messages": [
    {}
  ],
  "recurrence": {},
  "utm_tracking": {},
  "send_in_profile_time_zone": true,
  "send_if_profile_time_passed": true,
  "quiet_hours": {},
  "targeting": {},
  "deal_id": "1000251",
  "run_immediately": null
}'

const url = 'https://api.ocamba.com/v1/hood/campaigns/{id}';
const options = {
  method: 'PATCH',
  headers: {
    Authorization: "Bearer {TOKEN}",
    'Content-Type': "application/json"
  },
  body: JSON.stringify(
    {
      "name": "My First Campaign",
      "description": "This is my first campaign on the Hood application.",
      "labels": [
        "cars",
        "bwm",
        "audi",
        "volkswagen"
      ],
      "metadata": {},
      "scheduled_time": "2024-10-06 10:00:00",
      "ab_test": {},
      "messages": [
        {}
      ],
      "recurrence": {},
      "utm_tracking": {},
      "send_in_profile_time_zone": true,
      "send_if_profile_time_passed": true,
      "quiet_hours": {},
      "targeting": {},
      "deal_id": "1000251",
      "run_immediately": null
    }
  )
};

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}");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer {TOKEN}",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(
  [
    "name" => "My First Campaign",
    "description" => "This is my first campaign on the Hood application.",
    "labels" => [
      "cars",
      "bwm",
      "audi",
      "volkswagen"
    ],
    "metadata" => [],
    "scheduled_time" => "2024-10-06 10:00:00",
    "ab_test" => [],
    "messages" => [
      []
    ],
    "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

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