Update Push task

PATCH https://api.ocamba.com/v1/hood/push-tasks/{id}

Updates the specific Push task by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Warning

String Length Constraints: All text field length limits in this API are measured in bytes, not characters.

Multi-byte characters (such as emoji, Hebrew, Chinese, Japanese, and other non-ASCII symbols) consume multiple bytes per character and will reduce the effective character capacity:

Example: A field with a 60-byte limit can store 60 ASCII characters (“A”), 30 Cyrillic characters (“б”), 20 CJK characters (“中”), or 15 emoji ("😊").

Push task without start_time can not be active.
Push task with status “2” (finished) can not be edited.

Note

Push task start_time can not be in the past.
Push task end_time can not be set to date before start_time.
To repeat task on equal time intervals you can use frequency field. In order to have more control over repeating intervals you can use cron field. Check request examples for more info.

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/push-tasks/{id}" \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Demo edit",
  "adex": {
    "zone_id": "1000000",
    "account_id": null,
    "campaign_id": [],
    "group_id": null,
    "default_campaign_id": null,
    "number_of_messages": "2",
    "repeat_on_click": "1"
  },
  "targeting": {
    "countries": {
      "op": "include",
      "items": [
        "RS"
      ]
    },
    "apps": {
      "op": "include",
      "items": [
        "278686306",
        "326707096"
      ]
    }
  }
}'

const url = 'https://api.ocamba.com/v1/hood/push-tasks/{id}';
const options = {
  method: 'PATCH',
  headers: {
    Authorization: "Bearer {TOKEN}",
    'Content-Type': "application/json"
  },
  body: JSON.stringify(
    {
      "name": "Demo edit",
      "adex": {
        "zone_id": "1000000",
        "account_id": null,
        "campaign_id": [],
        "group_id": null,
        "default_campaign_id": null,
        "number_of_messages": "2",
        "repeat_on_click": "1"
      },
      "targeting": {
        "countries": {
          "op": "include",
          "items": [
            "RS"
          ]
        },
        "apps": {
          "op": "include",
          "items": [
            "278686306",
            "326707096"
          ]
        }
      }
    }
  )
};

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/push-tasks/{id}");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer {TOKEN}",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(
  [
    "name" => "Demo edit",
    "adex" => [
      "zone_id" => "1000000",
      "account_id" => null,
      "campaign_id" => [],
      "group_id" => null,
      "default_campaign_id" => null,
      "number_of_messages" => "2",
      "repeat_on_click" => "1"
    ],
    "targeting" => [
      "countries" => [
        "op" => "include",
        "items" => [
          "RS"
        ]
      ],
      "apps" => [
        "op" => "include",
        "items" => [
          "278686306",
          "326707096"
        ]
      ]
    ]
  ]
));
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