Detach a contact from a group conversation

Request

You can remove participants who are contacts from a group conversation, on behalf of an admin.

Removing the last participant

You cannot remove the last remaining contact from a conversation.

If the conversation is a ticket, the access token must include the write_tickets scope. Without it, the request returns a 401 with the error code token_unauthorized.

Security

bearerAuth

Path

conversation_idstringrequired

The identifier for the conversation as given by Intercom.

Example:123

contact_idstringrequired

The identifier for the contact as given by Intercom.

Example:123

Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:Preview

Bodyapplication/json

admin_idstringrequired

The id of the admin who is performing the action.

Example:"5017690"

curl -i -X DELETE \
  https://api.intercom.io/conversations/123/customers/123 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: Preview' \
  -d '{
    "admin_id": 991267739
  }'

Responses

Detach a contact from a group conversation

Bodyapplication/json

customersArray of objectsrequired

The conversation participants after the change

Example:

[
  {
    "type": "user",
    "id": "6762f1a61bb69f9f2193bbd8"
  }
]

Response

{
  "customers": [
    { … }
  ]
}