#Is contact blocked

Check if a contact is blocked.

#Method

GET

#Path

/contacts/isblocked/[phone_number]

#Path parameter

NameValueRequired?
phone_numberPhone number starting with the country code with or without leading plus. e.g. +16175551212 or 16175551212Yes

#Response

#HTTP status codes

CodeRemarks
200Request was successful.
400Validation error or request body was incorrectly formatted.
401Authentication failed. Check apikey header.
404Requested API endpoint not found.
429The rate limit has been reached.
500-511There was a problem processing the request on our server. Try again later.

#Response object

NameValueRemarks
statussuccess or error-
errorsArray of object { msg: [error detail] }Only present when status is error.
dataObject { is_blocked: true | false}Only present when status is success

#Code sample

curl --location --request GET 'https://api.sociocs.com/contact/isblocked/16175551212' \ --header 'apikey: your_api_key' \