Skip to main content
POST
Create queue

Authorizations

Authorization
string
header
required

API token in the sk_live_… format.

Body

application/json
name
string
required

Queue name.

Example:

"Suporte"

color
string
required

Tag color, in hexadecimal.

Example:

"#6941C6"

greetingMessage
string

Message sent to the contact when the ticket enters this queue.

Example:

"Olá! Você está falando com o Suporte."

outOfHoursMessage
string

Message sent to the contact outside the queue's business hours.

Example:

"Estamos fora do horário. Retornamos amanhã às 8h."

userIds
integer[]

Agents who work in this queue. The list you send replaces the previous one. Use the user id in this company, the same one GET /users returns. The same person has a different id in each company they work in.

Example:
wrapupTypeIds
integer[]

Wrap-ups available when closing a ticket in this queue.

Example:
automaticDistribution
boolean

Automatically distributes this queue's tickets among the agents who are online.

orderQueue
integer

Position of the queue in the list. Lower numbers appear first.

Example:

1

integrationId
integer

Chatbot integration linked to the queue.

Example:

4

Response

Created

data
object
Example: