Delete participant

Delete conversation participant

Removes a participant from the conversation

DELETEhttps://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantId}

Path parameters

workspaceId*string (uuid)

The workspace ID

Example: "b4e02c85-c6d2-4b15-8885-e09671799c61"

conversationId*string (uuid)

The conversation ID

Example: "67e4d358-ca94-421e-98b7-448860df9d33"

conversationParticipantId*string

The ID that refers to the conversation participant (e.g. the contact ID if the participant is a contact)

Example: "274bd6ff-3295-49a0-a02d-651fb661d7fb"

Response

204403404

Participant was removed

Request

JavaScriptCurlPython

const response = await fetch('https://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

404

{
  "code": "ResourceNotFound",
  "message": "The requested resource does not exist"
}

Examples

Request

curl -X DELETE "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations/c9c60caa-eaf5-4628-9687-91de4d452bfa/participants/af81b856-10fa-4994-90fa-a5ee862e758e" \
-H "Authorization: AccessKey abcd"