Create Blocked Contact

POST https://api.ocamba.com/v1/hood/blocked-contacts

Creates a new Blocked Contact

Warning

If a contact is added to the blocked-contact list, all profiles associated with that contact will have their explicit actionable removed, meaning they will no longer be engaged based on that actionable.

Note

The type of the contact will be determined by the system. The user has just to enter either a valid phone number in the e164 format, or a valid email.

Rate limits:

Burst: 10/s
Steady: 150/m

Request schema

body

Response schemas

›

201

application/json

›

400

application/json

›

500

application/json

curl -X POST \
 "https://api.ocamba.com/v1/hood/blocked-contacts" \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
  "contact": "+38112345678",
  "description": "Description example: Reason for listing phone number into blocked contact list."
}'

const url = 'https://api.ocamba.com/v1/hood/blocked-contacts';
const options = {
  method: 'POST',
  headers: {
    Authorization: "Bearer {TOKEN}",
    'Content-Type': "application/json"
  },
  body: JSON.stringify(
    {
      "contact": "+38112345678",
      "description": "Description example: Reason for listing phone number into blocked contact list."
    }
  )
};

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/blocked-contacts");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer {TOKEN}",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(
  [
    "contact" => "+38112345678",
    "description" => "Description example: Reason for listing phone number into blocked contact list."
  ]
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

curl -X POST \
 "https://api.ocamba.com/v1/hood/blocked-contacts" \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
  "contact": "[email protected]",
  "description": "Description example: Reason for listing email into blocked contact list."
}'

const url = 'https://api.ocamba.com/v1/hood/blocked-contacts';
const options = {
  method: 'POST',
  headers: {
    Authorization: "Bearer {TOKEN}",
    'Content-Type': "application/json"
  },
  body: JSON.stringify(
    {
      "contact": "[email protected]",
      "description": "Description example: Reason for listing email into blocked contact list."
    }
  )
};

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/blocked-contacts");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer {TOKEN}",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(
  [
    "contact" => "[email protected]",
    "description" => "Description example: Reason for listing email into blocked contact list."
  ]
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Responses

201 Created

{
  "id": "1016",
  "company_id": "12345678",
  "creator_id": "10101010",
  "contact": "* * * * * * * * * *",
  "type": "mobile_phone_number",
  "description": "Description example: Reason for listing contact into blocked contact list."
}

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