Management API

Get External Contacts List

This endpoint allows you to query all external contacts lists.

Get External Contact Activity

This endpoint allows you to query the external contact's activity records.

Create External Contact

This endpoint allows you to create an external contact.

This endpoint does not support external contact custom fields.

Update External Contact

This endpoint allows you to update external contact details.

This endpoint does not support external contact custom fields.

Create/Edit/Delete Contact Event Subscription

This endpoint allows you to subscribe to a webhook of a contact event, edit, and unsubscribe to the existing event.

The event hook will return the contact information when the following events are triggered:

• The external contact list is edited (Added contact, edited contact and deleted contact).
• The external contact has been merged.
• The external contact ownership was transferred.
• The new staff contact is created.
• The staff contact is updated.
• The staff contact is deleted.

Create/Edit/Delete External Contact Event Subscription

This endpoint allows you to subscribe to a webhook of an external contact event, edit, and unsubscribe to the existing event.

The event hook will return the contact information when the following events are triggered:

• The external contact list is updated (added, edited and deleted external contact)
• The external contact has been merged.

Get Staff Contact List

This endpoint allows you to get the staff contact list.

Create/Edit/Delete Staff Contact Event Subscription

This endpoint allows you to subscribe to a webhook of a staff contact event, edit, and uns

The event hook will return the contact information when the following events are triggered:

• The new staff contact is created.
• The staff contact is updated.
• The staff contact is deleted.

Get Supported Language List

This endpoint lets you retrieve the supported language list for creating the Service Group.

Get Supported Location List

This endpoint lets you retrieve the supported location list for creating the Service Group.

Create Destination - Service Group

This endpoint allows you to create a Service Group.

Update Destination - Service Group

This endpoint allows you to update the existing Service group.

Get Destination List

This endpoint allows you to retrieve the Tag and Destination lists.

Delete Destination - Service Group

This endpoint allows you to delete the Service group.

Create Tag

This endpoint allows you to create a tag.

Get Tag List

This endpoint allows you to retrieve the tag lists.

Update Tag

This endpoint allows you to update the existing tag.

Delete Tag

This endpoint allows you to delete the existing tag.

Get Label List

This endpoint allows you to retrieve the label list, including:

• Label ID
• Label Name
• Label Colour
• The staff who created the label
• The staff who updated the label
• The label creation day and time
• The label update day and time

Delete Label

This endpoint allows you to delete labels for an enquiry.

Label an Enquiry

This endpoint allows you to add and update labels to an enquiry.

Unlabel an enquiry

This endpoint allows you to remove labels to an enquiry.

Create/Edit/Delete Label Event Subscription

This endpoint allows you to subscribe to a webhook of a label event, edit, and unsubscribe to the existing event.

After the subscription, the event hook will return the label information when the event hook triggers are due to the following ​events:

• A new label is created
• A label is edited ​
• A label is deleted ​