Login and Logout APIs

Login

Method	APIs	Description
POST	Login API	Logs-in the user and creates a new session.

Logout

Method	APIs	Description
DELETE	Logout API	Logs-out an user and terminates the user session.

Login user using Single Sign-On

Single Sign-On using SAML

Method	APIs	Description
POST	Single Sign-On using SAML	ECE User Single Sign-On for WS APIs using SAML

Single Sign-On using SAML bearer token

Method	APIs	Description
POST	Single Sign-On using SAML bearer token	ECE user SSO login for WS APIs using SAML bearer token

Login Customer

Method	APIs	Description
POST	Login Customer	Logs-in the customer and creates a new session.

Logout Customer

Method	APIs	Description
POST	Logout Customer	Logs-out a customer and terminates the customer session.

Login Customer using Single Sign-On

Single Sign-On using SAML

Method	APIs	Description
POST	Single Sign-On using SAML	Logs-in customer using Single Sign-On using SAML.

Single Sign-On using SAML bearer token

Method	APIs	Description
POST	Single Sign-On using SAML bearer token	Logs-in the customer using Single Sign-On using SAML bearer token.

Logout Customer using Single Logout

Customer Single Logout service for Identity Provider initiated logout

Method	APIs	Description
POST	Customer Single Logout service for Identity Provider initiated logout	Logs-out a customer and terminates customer session at Identity Provider request.

Customer Single Logout service for Service Provider initiated logout

Method	APIs	Description
POST	Customer Single Logout service for Service Provider initiated logout	Confirms Identity Provider logout that's initiated by Service Provider.

Authenticate client application

Method	APIs	Description
POST	Authenticate client application	Authenticate client application

Revoke access token of client application

Method	APIs	Description
POST	Revoke access token of client application	Revoke access token of client application

Administration APIs

Group APIs

Search groups

Method	APIs	Description
GET	Search for Groups	Search for groups

User APIs

Search users

Method	APIs	Description
GET	User Search	Search for users

Get user roles

Method	APIs	Description
GET	Get User Roles	Get user roles

Get users by IDs

Method	APIs	Description
GET	Get Users by IDs	Get users by IDs

Get user by login ID

Method	APIs	Description
GET	Get User by login ID	Get user by login ID

Get user by external ID

Method	APIs	Description
GET	Get User by external ID	Get user by external ID

Get user attributes

Method	APIs	Description
GET	Get User Attributes	Get attributes for user resource

Create integrated user

Method	APIs	Description
POST	Create Integrated User	Create integrated user

Edit integrated user

Method	APIs	Description
PUT	Edit Integrated User	Edit integrated user

Delete user

Method	APIs	Description
DELETE	Delete user	Delete user

Delete user by external ID

Method	APIs	Description
DELETE	Delete user by external ID	Delete user by external ID

Queue APIs

Search queues

Method	APIs	Description
GET	Queue Search	Search for queues

Get queues by IDs

Method	APIs	Description
GET	Get Queues by IDs	Get queues by IDs

Get queue by external ID

Method	APIs	Description
GET	Get Queue by external ID	Get queue by external ID

Get queue attributes

Method	APIs	Description
GET	Get Queue Attributes	Get attributes for queue resource

Create queue

Method	APIs	Description
POST	Create Queue	Create queue

Create integrated queue

Method	APIs	Description
POST	Create Integrated Queue	Create integrated queue

Edit queue

Method	APIs	Description
PUT	Edit Queue	Edit queue

Edit integrated queue

Method	APIs	Description
PUT	Edit Integrated Queue	Edit integrated queue

Delete queue

Method	APIs	Description
DELETE	Delete queue	Delete queue

Delete queue by external ID

Method	APIs	Description
DELETE	Delete queue by external ID	Delete queue by external ID

Chat Entry Point APIs

Search Chat Entry Points

Method	APIs	Description
GET	Search Chat Entry Points	Search Chat Entry Points

Enable Chat Entry Point

Method	APIs	Description
GET	Enable Chat Entry Point	Enable Chat Entry Point

Disable Chat Entry Point

Method	APIs	Description
GET	Disable Chat Entry Point	Disable Chat Entry Point

Alias APIs

Get all aliases in the department

Method	APIs	Description
GET	Get aliases for department	Get all aliases in the department

Interaction APIs

Case APIs

Get case attributes

Method	APIs	Description
GET	Get Case Attributes	Get custom attributes for case resource

Get cases by IDs

Method	APIs	Description
GET	Get Cases by IDs	Get cases by IDs

Search for cases

Method	APIs	Description
GET	Case Search	Search for cases

Edit case

Method	APIs	Description
PUT	Edit Case	Edit case

Change customer for case

Method	APIs	Description
PUT	Change Customer for Case	Change customer for case

Close case

Method	APIs	Description
PUT	Close Case	Close case

Case Lookup

Method	APIs	Description
POST	Case Lookup	Case Lookup

Customer APIs

Get customer attributes

Method	APIs	Description
GET	Get Customer Attributes	Get attributes for customer resource like type, country, industry, level, contactPersons, and custom attributes.

Get customers by IDs

Method	APIs	Description
GET	Get Customers by IDs	Get customers by IDs

Search for customers

Method	APIs	Description
GET	Customer Search	Search for customers

Create individual customer

Method	APIs	Description
POST	Create Individual Customer	Create individual customer

Create group customer

Method	APIs	Description
POST	Create Group Customer	Create group customer

Create corporate customer

Method	APIs	Description
POST	Create Corporate Customer	Create corporate customer

Edit individual customer

Method	APIs	Description
PUT	Edit Individual Customer	Edit individual customer

Edit group customer

Method	APIs	Description
PUT	Edit Group Customer	Edit group customer

Edit corporate customer

Method	APIs	Description
PUT	Edit Corporate Customer	Edit corporate customer

Merge customer

Method	APIs	Description
PUT	Merge Customer	Merge customer

Create customer grants

Method	APIs	Description
POST	Create customer grants	Create grant on a customer

Get customer grants

Method	APIs	Description
GET	Get customer grants	Get grants of a customer

Delete customer grants

Method	APIs	Description
DELETE	Delete customer grants	Delete grants provided by a customer

Activity APIs

Get activity attributes

Method	APIs	Description
GET	Get Activity Attributes	Get attributes for activity resource like type, subtype, and custom attributes

Get activities by IDs

Method	APIs	Description
GET	Get Activities by IDs	Get activities by IDs

Search for activities

Method	APIs	Description
GET	Activity Search	Search for activities

Get activity attachments

Method	APIs	Description
GET	Get Activity Attachments	Get details for all attachments of an activity

Get attachment details

Method	APIs	Description
GET	Get Attachment Details	Get details of an activity attachment including content URL

Change customer of activities

Method	APIs	Description
PUT	Change Customer of Activities	Change customer of activities

Compose and save email activity

Method	APIs	Description
POST	Compose and Save Email Activity	Compose and save email activity

Create incoming email activity

Method	APIs	Description
POST	Create Incoming Email Activity	Create incoming email activity

Create calltrack activity

Method	APIs	Description
POST	Create Calltrack Activity	Create calltrack activity

Compose and send email activity

Method	APIs	Description
POST	Compose and send email activity	Compose and send email activity

Compose and send-complete email activity

Method	APIs	Description
POST	Compose and send-complete email activity	Compose and send-complete email activity

Edit activity

Method	APIs	Description
PUT	Edit Activity	Edit Activity

Edit completed activity

Method	APIs	Description
PUT	Edit Completed Activity	Edit completed activity

Mask activity

Method	APIs	Description
PUT	Mask activity	Mask Activity

Pull activities

Method	APIs	Description
PUT	Pull Activities	Pull activities from queues

Pick activities

Method	APIs	Description
PUT	Pick Activities	Pick activities from users and queues

Transfer activities to user

Method	APIs	Description
PUT	Transfer Activities to User	Transfer activities to user

Transfer activities to queue

Method	APIs	Description
PUT	Transfer Activities to Queue	Transfer activities to queue

Change case of Activities

Method	APIs	Description
PUT	Change Case of Activities	Change case of Activities

Complete Activities

Method	APIs	Description
PUT	Complete Activities	Complete Activities

Delete completed activity attachments

Method	APIs	Description
DELETE	Delete Completed Activity Attachments	Delete completed activity attachments

Note APIs

Create activity note

Method	APIs	Description
POST	Create activity note	Create activity note

Delete activity notes

Method	APIs	Description
DELETE	Delete activity notes	Delete activity notes

Get activity note by ID

Method	APIs	Description
GET	Get activity note by ID	Get activity note by ID

Get activity notes

Method	APIs	Description
GET	Get activity notes	Get activity notes

Create case note

Method	APIs	Description
POST	Create case note	Create case note

Delete case notes

Method	APIs	Description
DELETE	Delete case notes	Delete case notes

Get case note by ID

Method	APIs	Description
GET	Get case note by ID	Get case note by ID

Get case notes

Method	APIs	Description
GET	Get case notes	Get case notes

Create customer note

Method	APIs	Description
POST	Create customer note	Create customer note

Delete customer notes

Method	APIs	Description
DELETE	Delete customer notes	Delete customer notes

Get customer note by ID

Method	APIs	Description
GET	Get customer note by ID	Get customer note by ID

Get customer notes

Method	APIs	Description
GET	Get customer notes	Get customer notes

Messaging APIs

Get entrypoint configuration

Method	APIs	Description
GET	Get entrypoint configuration	Get entrypoint configuration

Start conversation

Method	APIs	Description
POST	Start conversation	Start conversation

Send message

Method	APIs	Description
POST	Send message	Send message

End conversation

Method	APIs	Description
PUT	End conversation	End conversation

Get conversation details

Method	APIs	Description
GET	Get conversation details	Get conversation details

Webhook callback

Method	APIs	Description
POST	Webhook callback	Webhook callback

Activate webhook callback URL

Method	APIs	Description
PUT	Activate webhook callback	Activate webhook callback URL

Common APIs

Get application details

Method	APIs	Description
GET	Get application details	Get application details