Create Blocked Contact

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

Creates a new Blocked Contact

Request Body Schema
Arrow
Name
Description
contactstringrequired
An actual actionable that can not be contacted.


Example: +1234567890
descriptionstringrequired
A reason for adding this contact to the Blocked Contact list.


Example: Description example.
Response status codes
Arrow
201 - Created
Arrow
400 - Bad Request
Arrow
500 - Internal Server Error
Arrow
warning
1 If a contact is added to the blocked-contact list, all users associated with that contact will have their explicit actionable removed, meaning they will no longer be engaged based on that actionable.
Request examples
Copied
Arrow
200 Arrow
  • 200
{
  "contact":"+38112345678",
  "description":"Description example: Reason for listing contact into blocked contact list."
}
Response examples
Copied
Arrow
201 Arrow
  • 201
  • 400
  • 500
{
  "id": "1016",
  "company_id": "12345678",
  "creator_id": "10101010",
  "contact": "* * * * * * * * * *",
  "type": "mobile_phone_number",
  "description": "Description example: Reason for listing contact into blocked contact list."
}   

{
  "code": 400,
  "title": "Bad request.",
  "message": "The request body is not valid.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}

{
  "code": 500,
  "title": "Internal server error.",
  "message": "Internal server error."
}