Intercom API (unofficial showcase)
DELETE/conversations/{conversation_id}/customers/{contact_id}

Detach a contact from a group conversation

Removes a contact from a group conversation on behalf of an admin. Supply the conversation and contact identifiers and the performing admin's ID. You cannot remove the last remaining contact from a conversation.

3 parameters · 1 body field
conversation_idstringrequired
The identifier of the conversation to remove the contact from.
contact_idstringrequired
The identifier of the contact to remove.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

Identifies the admin performing the participant removal.

admin_idstringrequired
The `id` of the admin who is performing the action.

5 status codes
200Returns the conversation's participants after the contact is detached.
customersarray<object>required
The conversation participants after the change
401Returned when the request is not authenticated.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
403Returned when the API plan restricts detaching contacts.

One documented failure

  • api_plan_restricted

    Active subscription needed.

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the contact cannot be found.

One documented failure

  • not_found

    Resource Not Found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
422Returned when the contact is the last remaining participant in the conversation.

One documented failure

  • parameter_invalid

    Removing the last customer is not allowed

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when authentication is missing or invalid; a 403 when the API plan restricts the operation; a 404 when the contact cannot be found; and a 422 when the contact is the conversation's last remaining participant. The conversation_id path parameter and contact_id path parameter must identify the conversation and contact. The request body must include admin_id.