Accept Chat

Claims an unassigned chat for the calling user.

Usually optional. Sending a message to an unassigned chat accepts it on the way through, so a simple integration can answer without accepting first. Accept explicitly when you want to claim a chat before deciding what to say.

Request

PUT /v2/chats/5a0da3c3-4882-3352-8db9-8fc47e14111f/accept HTTP/1.1
Authorization: Bearer oauth_token

Path Parameters

/v2/chats/{chatId}/accept

Accepting a chat the caller already holds changes nothing.

Response

Every write answers with the chat, in the same shape Get Chat returns — so a caller sees the result of what it just did without a follow-up read.

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
  "id": "5a0da3c3-4882-3352-8db9-8fc47e14111f",
  "beaconId": "ed8e9fe0-acf4-4b44-b1fc-a5bff956e7a8",
  "mailboxId": 2599,
  "createdAt": "2020-07-03T07:03:29.982028Z",
  "assignee": { "id": 4440, "type": "agent", "first": "Jack", "last": "Sprout" },
  "customer": { "id": 498746, "type": "customer", "first": "Vernon", "last": "Bear" },
  "_embedded": {
    "events": [ "..." ]
  },
  "_links": {
    "self": { "href": "..." }
  }
}

The full field reference is on Get Chat.

Errors

Status When
403 The caller cannot use chat, has no name on their profile, or cannot access the chat’s inbox
404 No such chat, the chat belongs to another company, or the chat has ended
↑Back to top