Unassign Chat

Releases a chat back to the queue, so any available agent can take it.

This is how the calling user steps away from a chat. It is not the same as ending it — the chat stays open and the visitor stays in it.

Request

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

Path Parameters

/v2/chats/{chatId}/unassign

Unassigning also leaves the visitor with no indication that anything happened. As with assignment, say something first.

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