Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
Service Agent

Join a talk chat

Allows the authenticated agent to join a "talk" type chat (public channel). This is a convenience endpoint that automatically adds the agent as a participant. Only works for "talk" type chats - for group/direct chats, use the participants endpoint.

post/service_agents/talk_chats/{id}/join

Path parameters

idstring required

The talk chat ID to join.

Response

Successfully joined the chat.

idstring uuid

The unique identifier of the participant.

customer_idstring uuid

The unique identifier of the customer. Returned from the GET /customers response.

owner_typestring

Resource's owner type.

owner_idstring uuid

The unique identifier of the participant owner. Returned from the corresponding owner resource endpoint.

chat_idstring uuid

The unique identifier of the talk this participant belongs to. Returned from the GET /service_agents/talk_chats response.

tm_joinedstring date-time

Timestamp when the participant joined the talk.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "owner_type": "agent",
  "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  "chat_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
  "tm_joined": "2026-01-15T10:00:00.000000Z"
}