Check if a contact is blocked

Check whether a specific contact is currently blocked. Use when managing the outbound-messaging exclusion list — e.g. honouring a recipient opt-out or reconciling against an…

GET /blocklist/contacts/check/{contact_id}

Check if a contact is blocked

cURL

curl --request GET \
  --url https://api.open.cx/blocklist/contacts/check/{contact_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "is_blocked": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

contact_id · string · required

Response

200

application/json

Default Response

is_blocked · boolean · required