Parameter name | Value | Description |
---|---|---|
id |
string |
Identifier of the queue. |
author |
string |
Author of the queue. |
name |
string |
Name of the queue. Writable. Max length: 127. |
thankMessage |
string |
Thank message of the queue. Writable. Max length: 65535. |
welcomeMessage |
string |
Welcome message of the queue. Writable. Max length: 65535. |
company |
string |
Company linked with the queue. |
company.id |
string |
Id of the company. |
company.name |
string |
Name of the company. Writable. |
form |
string |
Form linked with the queue. |
form.id |
string |
Id of the form. Writable. |
form.name |
string |
Name of the form. |
Authentication is required to execute this request. Please refer to Authentication for more.
{queueId}
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
queueId |
string |
queue identifier. |
Do not supply a request body with this method.
If successful, this method returns an empty response body.
Authentication is required to execute this request. Please refer to Authentication for more.
{queueId}
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
queueId |
string |
Queue identifier. |
Do not supply a request body with this method.
If successful, this method returns a Queue resource in the response body.
Authentication is required to execute this request. Please refer to Authentication for more.
Parameter name | Value | Description |
---|---|---|
Optional query parameters | ||
companyId |
string |
Company identifier. |
Do not supply a request body with this method.
If successful, this method returns a response body with the following structure:
Authentication is required to execute this request. Please refer to Authentication for more.
In the request body, supply a Queue Resource with the following properties:
Parameter name | Value | Description |
---|---|---|
Required Properties | ||
name |
string |
Name of the queue. |
company |
string |
Company linked with the queue. |
company.id |
string |
Id of the company. |
Optional Properties | ||
company.name |
string |
Name of the field. |
form |
string |
Form linked with the queue. |
form.id |
string |
Id of the form. |
form.name |
string |
Name of the form. |
If successful, this method returns a Queue resource in the response body.
Authentication is required to execute this request. Please refer to Authentication for more.
{queueId}
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
queueId |
string |
Queue identifier. |
In the request body, supply a Queue resource with the following properties:
Parameter name | Value | Description |
---|---|---|
Optional Properties | ||
thankMessage |
string |
Thank message of the queue. |
welcomeMessage |
string |
Welcome message of the queue. |
company |
string |
Company linked with the queue. |
company.id |
string |
Id of the company. |
company.name |
string |
Name of the company. |
form |
string |
Form linked with the queue. |
form.id |
string |
Id of the form. |
form.name |
string |
Name of the form. |
If successful, this method returns a Queue resource in the response body.