Agendize Chat API

Chat Buttons


Resource representation

{ "id": {string}, "name": {string}, "proactive" : {boolean}, "status" : {string}, "offline" : { "message" : {string}, "form" : { "id" : {string}, "name" : {string} } }, "contactForm" : { "status" : {string} } }
Parameter name Value Description
id string Identifier of the chat button. Read-only
name string Name of the chat button.
proactive boolean Set to True to set the chat button proactive.
status string Status of the chat button. Values "enabled"/"disabled".
offline object Offline configuration of the chat button.
offline.message string Offline message of the chat button.
offline.form object Offline form object of the chat button.
offline.form.id string Offline form id of the chat button. Default "0".
offline.form.name string Offline form name of the chat button. Optional if form.id is set to the default value.
contactForm object Contact form configuration of the chat button.
contactForm.status string Status of the contact form of the chat button. Values "enabled"/"disabled". If set to "enabled", an email will be required to start a chat session.

Delete

Deletes an entry on the chat button list.

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

Request

HTTP Request

DELETE https://api.agendize.com/api/2.0/chat/buttons/{buttonId}

Parameters

Parameter name Value Description
Path parameters
buttonId string Chat button identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.


Get

Returns an entry of the chat button 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/chat/buttons/{buttonId}

Parameters

Parameter name Value Description
Path parameters
buttonId string Button identifier.

Request body

Do not supply a request body with this method.

Response

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


List

Returns entries on the chat button 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/chat/buttons

Request body

Do not supply a request body with this method.

Response

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


Insert

Adds an entry to the chat button list.

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

Request

HTTP Request

POST https://api.agendize.com/api/2.0/chat/buttons

Request body

In the request body, supply a Chat button resource with the following properties:

Parameter name Value Description
Required Properties
name string Name of the chat button.

Response

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


Update

Updates an entry on the chat button list.

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

Request

HTTP Request

PUT https://api.agendize.com/api/2.0/chat/buttons/{buttonId}

Parameters

Parameter name Value Description
Path parameters
buttonId string Chat button identifier.

Request body

In the request body, supply a Chat button resource with the following properties:

Parameter name Value Description
Optional Properties
name string Name of the chat button.

Response

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