CRUD api create request.

CxEngage.api.create({
  path: {{array}} (required) Example Array ['groups', '0000-0000-0000-0000', 'outboundIdentifierLists']
  body: {{object}} (required)
  customTopic: {{string}} (optional)
  apiVersion: {{string}} (optional) (If this attribute is passed, it will be able to override the default api version used to make the
                                     requests, set up when initializing the SDK, to any existing version on the platform.
                                     E.g., 'v2', 'v3'. etc)
});

A generic method for creating an api entity.

Possible Errors:

• Api: 11098

CRUD api delete request.

CxEngage.api.delete({
  path: {{array}} (required) Example Array ['groups', '0000-0000-0000-0000', 'outboundIdentifierLists']
  customTopic: {{string}} (optional)
  apiVersion: {{string}} (optional) (If this attribute is passed, it will be able to override the default api version used to make the
                                     requests, set up when initializing the SDK, to any existing API version on the platform.
                                     E.g., 'v2', 'v3'. etc)
});

A generic method for deleting an api entity.

Possible Errors:

• Api: 11101

CRUD api get request.

CxEngage.api.read({
  path: {{array}} (required) Example Array ['groups', '0000-0000-0000-0000', 'outboundIdentifierLists']
  customTopic: {{string}} (optional)
  apiVersion: {{string}} (optional) (If this attribute is passed, it will be able to override the default api version used to make the
                                     requests, set up when initializing the SDK, to any existing version on the platform.
                                     E.g., 'v2', 'v3'. etc)
  tenantId: {{string}} (optional)  (In the Tenants page, we need to fetch entities data that belong to a different tenant.)
  platformEntity: {{boolean}} (optional) (Entities like regions & timezones are platform-level entities, which needs to fetched without sending tenantId in the request)
});

A generic method of retrieving an api endpoint.

Topic: cxengage/api/read-response

• Api Documentation

Possible Errors:

• Api: 11099

CRUD api update request.

CxEngage.api.update({
  path: {{array}} (required) Example Array ['groups', '0000-0000-0000-0000', 'outboundIdentifierLists']
  body: {{object}} (required)
  customTopic: {{string}} (optional)
  apiVersion: {{string}} (optional) (If this attribute is passed, it will be able to override the default api version used to make the
                                     requests, set up when initializing the SDK, to any existing version on the platform.
                                     E.g., 'v2', 'v3'. etc)
});

A generic method for updating an api entity.

Possible Errors:

• Api: 11100