Unsubscribe Users

Unsubscribe Users

POST https://api.ocamba.com/v1/hood/users/unsubscribe
Unsubscribes a User

Rate limits:

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

Request schema

body

Response schemas

204
No Content
curl -X POST \
 "https://api.ocamba.com/v1/hood/users/unsubscribe" \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
  "client_id": [
    "1234567890",
    "9876543210"
  ]
}'
const url = 'https://api.ocamba.com/v1/hood/users/unsubscribe';
const options = {
  method: 'POST',
  headers: {
    Authorization: "Bearer {TOKEN}",
    'Content-Type': "application/json"
  },
  body: JSON.stringify(
    {
      "client_id": [
        "1234567890",
        "9876543210"
      ]
    }
  )
};

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/users/unsubscribe");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer {TOKEN}",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(
  [
    "client_id" => [
      "1234567890",
      "9876543210"
    ]
  ]
));
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 body 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
Note
List of client ids represents users you want to unsubscribe.