Delete participant

Delete conversation participant

delete

Removes a participant from the conversation

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstring · uuidRequired

The workspace ID

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

conversationIdstring · uuidRequired

The conversation ID

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

conversationParticipantIdstring · min: 1Required

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

Responses

204

Participant was removed

403

Deleting this participant is not allowed

404

The resource specified in the URL was not found

application/json

delete

HTTPcURLJavaScriptPython

DELETE /workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantId} HTTP/1.1
Host: api.bird.com
Authorization: Bearer JWT
Accept: */*

No content

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"