v51

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

Service Agent

Create a new talk chat

Creates a new talk chat and returns the created talk's details.

Participant requirements by type:

direct: Requires exactly 1 other participant (creator is automatically added as second participant)
group: Can start with 0 or more participants (creator is automatically added, members can be added/removed later)
talk: No additional participants required (creator is automatically added)

Note: If the creator includes themselves in the participants list, they will not be added twice.

post/service_agents/talk_chats

Request body

type'direct' | 'group' | 'talk' required

Type of the talk.

namestring

Talk name (optional).

detailstring

Talk description/detail (optional).

Example request

{
  "type": "direct",
  "participants": [
    {
      "owner_type": "agent",
      "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90"
    }
  ]
}

Response

The created talk chat's details.

idstring uuid

The unique identifier of the talk. Returned from the POST /service_agents/talk_chats or GET /service_agents/talk_chats response.

customer_idstring uuid

The unique identifier of the customer who owns this talk. Returned from the GET /customers response.

type'direct' | 'group' | 'talk'

Type of the talk.

namestring

Talk name (optional).

detailstring

Talk description/detail (optional).

member_countinteger

Number of participants in this chat.

tm_createstring date-time

Timestamp when the talk was created.

tm_updatestring date-time

Timestamp when the talk was last updated.

tm_deletestring date-time

Timestamp when the talk was deleted.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "type": "direct",
  "name": "Sales Team Chat",
  "detail": "Internal chat for the sales team",
  "member_count": 5,
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-16T14:20:00.000000Z",
  "tm_delete": "2026-01-17T18:45:00.000000Z"
}