Update Hood Engage settings

Update Hood Engage settings

PATCH https://api.ocamba.com/v1/hood/settings
Updates the Hood Engage settings. Any parameters not provided will be left unchanged

Rate limits:

  • Burst: 10/s
  • Steady: 150/m

Request schema

body

Response schemas

204
No Content
curl -X PATCH \
 "https://api.ocamba.com/v1/hood/settings" \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
  "engagement_score": {
    "low_engagement": {
      "from": 3,
      "to": 12
    },
    "medium_engagement": {
      "from": 13,
      "to": 65
    },
    "high_engagement": {
      "from": 66,
      "to": 100
    },
    "advanced_settings": {
      "purchase": 67,
      "sms_click": 10,
      "web_push_click": 15
    }
  }
}'
const url = 'https://api.ocamba.com/v1/hood/settings';
const options = {
  method: 'PATCH',
  headers: {
    Authorization: "Bearer {TOKEN}",
    'Content-Type': "application/json"
  },
  body: JSON.stringify(
    {
      "engagement_score": {
        "low_engagement": {
          "from": 3,
          "to": 12
        },
        "medium_engagement": {
          "from": 13,
          "to": 65
        },
        "high_engagement": {
          "from": 66,
          "to": 100
        },
        "advanced_settings": {
          "purchase": 67,
          "sms_click": 10,
          "web_push_click": 15
        }
      }
    }
  )
};

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/settings");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer {TOKEN}",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(
  [
    "engagement_score" => [
      "low_engagement" => [
        "from" => 3,
        "to" => 12
      ],
      "medium_engagement" => [
        "from" => 13,
        "to" => 65
      ],
      "high_engagement" => [
        "from" => 66,
        "to" => 100
      ],
      "advanced_settings" => [
        "purchase" => 67,
        "sms_click" => 10,
        "web_push_click" => 15
      ]
    ]
  ]
));
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