Agents
Remove an agent from a webchat conversation
Removes a non-primary participant agent from a conversation owned by the authenticated user. The removed agent receives no further turns or context from the conversation; its earlier replies stay in the history. The primary agent cannot be removed. Idempotent for an agent that is not in the roster.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
orgId*string
conversationId*string
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidagentId*string
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidResponse Body
application/json
application/json
application/json
curl -X DELETE "https://example.com/v1/orgs/string/webchat/conversations/497f6eca-6276-4993-bfeb-53cbbbba6f08/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "participants": [ { "agentId": "string", "primary": true } ]}