Introduction

The CINNOX Open API Management provides endpoints to do the following to your CINNOX service account:

API EndpointDescriptionRemark
Get External Contacts ListThis endpoint allows you to query all external contacts list.
Get External Contact ActivityThis endpoint allows you to query the external contact's activity records.
Create External ContactThis endpoint allows you to create an external contact.This endpoint does not support external contact custom fields.
Update External ContactThis endpoint allows you to update an external contact details.This endpoint does not support external contact custom fields.
Create/Edit/Delete Contact Event SubscriptionThis endpoint allows you to create a new webhook event / edit the subscribed event for an application. And also allow you to delete the contact event under your application account.The event hook will return the external 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.
Get Staff contact listThis endpoint allows you to get the staff contact list.
Get Supported Language ListThis endpoint allows you to retrieve the supported language list available for creating the Service Group in Destination.
Get Supported Location ListThis endpoint allows you to retrieve the supported location list available for creating the Service Group in Destination.
Create Destination - Service GroupThis endpoint allows you to create a destination - service group.
Update Destination - Service GroupThis endpoint allows you to update the existing destination - service group
Get Destination ListThis endpoint allows you to retrieve the Tag and Destination lists.
Delete Destination - Service GroupThis endpoints allows you to delete the destination - service group.
Create TagThis endpoints allows you to create a tag.
Get Tag ListThis endpoint allows you to retrieve the tag lists.
Update TagThis endpoint allows you to update the existing tag.
Delete TagThis endpoint allows you to delete the existing tag.
Get Label ListThis 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 LabelThis endpoint allows you to delete labels to an enquiry
Label an EnquiryThis endpoint allows you to add and update labels to an enquiry.
Unlabel an enquiryThis endpoint allows you to remove labels to an enquiry.
Create/Edit/Delete Label Event SubscriptionThis endpoint allows you to create a new webhook subscription and edit and delete the subscription under your application account.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 ​

 

📘

CINNOX Open API support up to 500 requests per min per service account.