Agendize Developers API

Agendize queues API

Queues

Resource representation

{ "id": {string}, "author": {string}, "name": {string}, "thankMessage": {string}, "welcomeMessage": {string}, "company": { "id": {string}, "name": {string} }, "form": { "id": {string}, "name": {string} } }
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.

Delete

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

DELETE https://api.agendize.com/api/2.0/queues/{queueId}

Parameters

Parameter name Value Description
Path parameters
queueId string queue identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.

Get

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.0/queues/{queueId}

Parameters

Parameter name Value Description
Path parameters
queueId string Queue identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Queue resource in the response body.

List

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.0/queues

Parameters

Parameter name Value Description
Optional query parameters
companyId string Company identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{ items: [Queue Resource] }

Insert

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

POST https://api.agendize.com/api/2.0/queues

Request body

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.

Response

If successful, this method returns a Queue resource in the response body.

Update

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

PUT https://api.agendize.com/api/2.0/queues/{queueId}

Parameters

Parameter name Value Description
Path parameters
queueId string Queue identifier.

Request body

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.

Response

If successful, this method returns a Queue resource in the response body.

Agendize | Support | Status

Last update: Mar 18, 2024 - Copyright © 2024 Agendize. All rights reserved.