View Blocked Contact

GET /blocked-contacts/{id}
Copied
Arrow
                https://api.ocamba.com/v1/hood/blocked-contacts/{id}

Retrieves the details of a Blocked Contact Object that has previously been created if a valid identifier is provided

path Parameters
Arrow
Name
Description
idstringrequired
Unique resource identifier.


Example: 12345
query Parameters
Arrow
Name
Description
fieldsstring
Fields parameter represents array of dimensions and measures. Dimensions are used to categorize, segment, and reveal the details of the data. Measures contain numeric, quantitative values that can be measured. At least one measure is required.


Example: fields=field1,field2,field3
viewstring
Hood API returns full representation of the resource using the "view=full" query parameter. If not specified, the default view will be used.

Note that the "fields" parameter has precedence over the "view" parameter.


Example: view=full/default
read_gdpr_fieldsstring
Describes if the PI data located on the object are going to be displayed as hidden, or real values.


Example: read_gdpr_fields=true

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ blocked-contact ]
An array of all created items.
Blocked Contact
Name
Description
company_idstring
A unique company identifier generated by the Ocamba.


Example: 7196310
contactstring
An actual actionable that can not be contacted.


Example: +1234567890
create_timestring
Timezone: GMT.


Example: 2021-10-29 12:47:00
creatorcreator
A unique identifier for the creator, generated by Ocamba, who is also a Ocamba member.
Creator
Name
Description
company_idstring
A unique company identifier generated by the Ocamba platform.


Example: 1000000
idstring
A unique identifier generated by the Ocamba platform.


Example: 1000163
imagestring (url)
The image of the member.


Example: https://image-uri-example.com
namestring
Name of the Ocamba member.


Example: John Doe
statusstring
Describe Ocamba member status.


Example: active

Possible values: active | suspended

Default: active
creator_idstring
A unique member identifier generated by the Ocamba.


Example: 1000163
descriptionstring
A reason for adding this contact to the Blocked Contact list.


Example: Description example.
idstring
A unique identifier generated by the Ocamba.


Example: 450
typestring
Type of actionable that can not be contacted.


Example: mobile_phone_number

Possible values: mobile_phone_number | email
update_timestring
Timezone: GMT.


Example: 2021-10-30 14:27:26
totalinteger
A total number of items.


Example: 1
500 - Internal Server Error
Arrow
Name
Description
codeinteger
Http response status code.


Example: 500
messagestring
The human readable message that describes how to deal with error.


Example: Internal server error.
titlestring
The error title.


Example: Internal server error.
tip
1 If you don't know the blocked contact id, list the blocked contacts to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
  • 500
{
    "total": 1,
    "items": [
      {
        "id": "1021",
        "company_id": "123456",
        "contact": "* * * * * * * * * *",
        "description": "Description example: Reason for listing subscription into do not contact list.",
        "create_time": "2025-02-13 08:41:44",
        "update_time": "2025-02-13 08:41:44"
      }
    ]
}

{
  "total": 1,
  "items": [
    {
      "id": "450",
      "company_id": "7196310",
      "creator_id": "1000163",
      "creator": {
        "id": "1000163",
        "company_id": "1000000",
        "name": "John Doe",
        "status": "active",
        "image": "https://image-uri-example.com"
      },
      "contact": "+1234567890",
      "type": "mobile_phone_number",
      "description": "Description example.",
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}

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