/api/v1/tickets/{id}/takeover

PATCH

/api/v1/tickets/{id}/takeover

curl --request PATCH \
  --url https://api.endless.zaia.app/api/v1/tickets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/takeover \
  --header 'Content-Type: application/json' \
  --data '{ "assigneeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

• API Server

Takes over a ticket.

Parameters

Path Parameters

id

required

A UUID v4 string that identifies an entity.

string format: uuid

A UUID v4 string that identifies an entity.

Request Body^required

Media typeapplication/json

object

assigneeId

required

A UUID v4 string that identifies an entity.

string format: uuid

Example^generated

{
  "assigneeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

The ticket was taken over.

Media typeapplication/json

object

createdAt

required

string format: date-time

id

required

A UUID v4 string that identifies an entity.

string format: uuid

updatedAt

required

string format: date-time

assigneeId

required

The id of the user assigned to the ticket.

string format: uuid

nullable

chatId

required

A UUID v4 string that identifies an entity.

string format: uuid

circumstance

required

The type of ticket creation: takeover (human intervention) or handover (agent automatic creation).

string

Allowed values: takeover handover

completedAt

required

string format: date-time

nullable

lastViewedAt

required

The last time the ticket was viewed by the assignee.

string format: date-time

nullable

ongoingAt

required

string format: date-time

nullable

status

required

string

Allowed values: pending ongoing completed

summary

required

A brief summary of the chat up until the ticket was created.

string

ticketingTeamId

required

The id of the ticketing team responsible for the ticket.

string format: uuid

nullable

Example

{
  "circumstance": "takeover",
  "status": "pending"
}

401

Unauthorized.

Media typeapplication/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}

404

Ticket not found.

Media typeapplication/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}

412

Ticket is not ongoing or already assigned.

Media typeapplication/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}