Skip to main content
PUT
/
api
/
v1
/
contacts
/
{id}
/
block
Block or Unblock Contact
curl --request PUT \
  --url http://localhost:8080/api/v1/contacts/{id}/block \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": false
}
'
{
  "status": "success",
  "data": {
    "id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "[email protected]",
    "type": "<string>",
    "availability_status": "<string>",
    "avatar_url": "<string>",
    "phone_number": "<string>",
    "phone_number_country_code": "<string>",
    "custom_attributes": {},
    "enabled": true,
    "last_active_at": "2023-11-07T05:31:56Z",
    "last_login_at": "2023-11-07T05:31:56Z",
    "roles": [
      "<string>"
    ],
    "permissions": [
      "<string>"
    ],
    "teams": [
      {}
    ],
    "api_key": "<string>",
    "api_key_last_used_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication using base64 encoded API key and secret. Format: Authorization: Basic <base64(api_key:api_secret)>

Path Parameters

​
id
string
required

Body

application/json

Update the contact's block status.

​
enabled
boolean
required

Set to false to block, true to unblock

Example:

false

Response

Contact block status updated successfully

​
status
string
Example:

"success"

​
data
object