CxEngage.entities.associate({
  originEntity: {
    name: {{string}}, (required)
    id: {{string}}, (required)
  },
  destinationEntity: {
    name: {{string}}, (required)
    id: {{string}}, (required)
  }
});

Associates item from the entity requested. For example , add a user to a group or skill.

Topic: cxengage/entities/associate-response

Possible Errors:

• Entities: 11066

CxEngage.entities.createApiKeys({
  name: {{string}},
  description: {{string}}, (optional)
  role-id: {{string}}
});

Creates new ApiKey by calling rest/create-api-key-request with the provided data.

Topic: cxengage/entities/create-api-key-response

Possible Errors:

• Entities: 11061

CxEngage.entities.createBusinessHour({
  name: {{string}} (required),
  timezone: {{string}} (required),
  description: {{string}} (optional),
  active: {{boolean}} (required),
  timeMinutes: {
    monStartTimeMinutes: {{integer}} (required, between 0 and 1440),
    monEndTimeMinutes: {{integer}} (required, between 0 and 1440),
    ...
    sunStartTimeMinutes: {{integer}} (required, between 0 and 1440),
    sunEndTimeMinutes: {{integer}} (required, between 0 and 1440),
  } (required)
});

Calls rest/create-business-hour-request with the provided data for current tenant.

Topic: cxengage/entities/create-business-hours-response

Possible Errors:

• Entities: 11129

CxEngage.entities.createDataAccessReport({
  name: {{string}},
  description: {{string}}, (optional)
  active: {{boolean}},
  realtimeReportId: {{uuid}}, (optional)
  reportType: {{string}},
  realtimeReportType: {{string}}, (optional)
  realtimeReportName: {{string}}, (optional)
  historicalCatalogName: {{string}}, (optional)
  users: {{array}} (optional)
});

Creates new single Data Access Report by calling rest/create-data-access-report-request with the provided data for current tenant.

Topic: cxengage/entities/create-data-access-report-response

Possible Errors:

• Entities: 11055

CxEngage.entities.createDispatchMapping({
  name: {{string}} (required),
  description: {{string}} (optional),
  value: {{string}} (required),
  flowId: {{uuid}} (required),
  version: {{uuid || nil}} (optional),
  channelType: {{string}} (required),
  interactionField: {{string}} (required),
  active: {{boolean}} (required),
});

Calls rest/create-dispatch-mapping-request with the provided data for current tenant.

Topic: cxengage/entities/create-dispatch-mapping-response

Possible Errors:

• Entities: 11095

CxEngage.entities.createDisposition({
   name: {{string}} (required),
   description: {{string}} (optional),
   externalId: {{string}} (optional),
   active: {{boolean}} (required),
   shared: {{boolean}} (required),
});

Calls rest/create-disposition-request with the provided data for current tenant.

Topic: cxengage/entities/create-disposition-response

Possible Errors:

• Entities: 11091

CxEngage.entities.createDispositionList({
  name: {{string}} (required),
  description: {{string}} (optional),
  externalId: {{string}} (optional),
  active: {{boolean}} (required),
  shared: {{boolean}} (required),
  dispositions: {{object}} (optional)
});

Calls rest/create-disposition-list-request with the provided data for current tenant.

Topic: cxengage/entities/create-disposition-list-response

Possible Errors:

• Entities: 11138

CxEngage.entities.createEmailTemplate({
  emailTypeId: {{uuid}},
  active: {{boolean}},
  shared: {{boolean}},
  subject: {{string}},
  body: {{string}}
});

Create new email template for current tenant

Possible Errors:

• Entities: 11034

CxEngage.entities.createException({
  businessHoursId: {{uuid}} (required)
  date: {{Date object}} (required),
  isAllDAy: {{boolean}} (required),
  description: {{string}} (optional),
  startTimeMinutes: {{ integer }} (required, between -1 and 1440)
  startTimeMinutes: {{ integer }} (required, between -1 and 1440)
});

Calls rest/create-exception-request with the provided data for current tenant.

Topic: cxengage/entities/create-exception-response

Possible Errors:

• Entities: 11129

CxEngage.entities.createFlow({
  flowType: {{string}}, (required) (for new/copy of flow)
  name: {{string}}, (required) (for new/copy of flow)
  active: {{boolean}}, (optional) (for new/copy of flow)
  description: {{string}} (optional) (for new/copy of flow)
  flow: {{string}}, (optional) (for new initial draft)
  metadata: {{string}}, (optional) (for new initial draft)
});

Creates new single/copy Flow and its Initial Draft by calling rest/create-flow-request with the provided data for current tenant.

Topic: cxengage/entities/create-flow-response

Possible Errors:

• Entities: 11085

CxEngage.entities.createFlowDraft({
  flowId: {{uuid}}, (required)
  name: {{string}}, (required)
  flow: {{string}}, (optional)
  metadata: {{string}}, (optional)
  description: {{string}} (optional)
});

Creates new single Flow Draft by calling rest/create-flow-draft-request with the provided data for current tenant.

Topic: cxengage/entities/create-flow-draft-response

Possible Errors:

• Entities: 11086

CxEngage.entities.createGroup({
  name: {{string}},
  description: {{string}}, (optional)
  active: {{boolean}}
});

Creates new single Group by calling rest/create-group-request with the provided data for current tenant.

Topic: cxengage/entities/create-group-response

Possible Errors:

• Entities: 11061

CxEngage.entities.createIntegration({
  name: {{string}} (required),
  description: {{string}} (optional),
  active: {{boolean}} (required),
  integrationType: {{string}} (required),
  properties: {{object}} (optional)
});

Calls rest/create-integration-request with the provided data for current tenant.

Topic: cxengage/entities/create-integration-response

Possible Errors:

• Entities: 11110

CxEngage.entities.createIntegrationListener({
  integrationId: {{uuid}}, (required)
  name: {{string}} (required),
  active: {{boolean}} (optional),
  properties: {{object}} (optional),
  listener-type: {{string}} (optional)
});

Creates new single Integration Listener by calling rest/create-integration-listener-request with the provided data for current tenant.

Topic: cxengage/entities/create-integration-listener-response

Possible Errors:

• Entities: 11114

CxEngage.entities.createList({
  listTypeId: {{uuid}},
  name: {{string}},
  shared: {{boolean}},
  active: {{boolean}}
});

Create new generic list for current tenant

Possible Errors:

• Entities: 11012

CxEngage.entities.createListItem({
  listId: {{uuid}},
  itemValue: {{object}}
});

Create new generic list item for current tenant

Possible Errors:

• Entities: 11013

CxEngage.entities.createMessageTemplate({
  name: {{string}} (required),
  description: {{string}} (optional),
  channels: {{array}} (required),
  templateTextType: {{string}} (required),
  template:{{string}} (required),
  active: {{boolean}} (required),
});

Calls rest/create-message-template-request with the provided data for current tenant.

Topic: cxengage/entities/create-message-template-response

Possible Errors:

• Entities: 11124

CxEngage.entities.createOutboundIdentifier({
  name: {{string}} (optional)
  active: {{boolean}} (optional)
  value: {{string}} (optional)
  flowId: {{string}} (optional)
  channelType: {{string}} (optional)
  description: {{string}} (optional)
});

Creates single Outbound Identifier by calling rest/create-outbound-identifier-request with the provided data for current tenant.

Topic: cxengage/entities/create-outbound-identifier-response

Possible Errors:

• Entities: 11030

CxEngage.entities.createOutboundIdentifierList({
  active: {{boolean}},
  name: {{string}},
  description: {{string}} (optional)
});

Create new list of outbound identifiers for current tenant

Possible Errors:

• Entities: 11034

CxEngage.entities.createReason({
     name: {{string}} (required),
     description: {{string}} (optional),
     externalId: {{string}} (optional),
     active: {{boolean}} (required),
     shared: {{boolean}} (required),
});

Calls rest/create-reason-request with the provided data for current tenant.

Topic: cxengage/entities/create-reason-response

Possible Errors:

• Entities: 11078

CxEngage.entities.createReasonList({
  name: {{string}} (required),
  description: {{string}} (optional),
  externalId: {{string}} (optional),
  active: {{boolean}} (required),
  shared: {{boolean}} (required),
  reasons: {{object}} (optional),
  isDefault: {{boolean}} (optional),
});

Calls rest/create-reason-list-request with the provided data for current tenant.

Topic: cxengage/entities/create-reason-list-response

Possible Errors:

• Entities: 11080

CxEngage.entities.createRole({
  name: {{string}},
  description: {{string}},
  permissions: {{array}},
  active: {{boolean}},
  shared: {{boolean}}
});

Create Role for current logged in tenant

Possible Errors:

• Entities: 11050

CxEngage.entities.createSkill({
  name: {{string}},
  description: {{string}}, (optional)
  active: {{boolean}},
  hasProficiency: {{boolean}} (optional)
});

Creates new single Skill by calling rest/create-skill-request with the provided data for current tenant.

Topic: cxengage/entities/create-skill-response

Possible Errors:

• Entities: 11058

javascript CxEngage.entities.createSla({ name: {{string}}, (required) description: {{string}}, (optional) active: {{boolean}}, (optional) shared: {{boolean}}, (required) activeSla: {{object}} (optional) });

Example activeSla activeSla: { ‘versionName’: {{string}} (optional) ‘versionDescription’: {{string}} (optional) ‘slaThreshold’: {{integer}} (optional) ‘abandonType’: {{string}} (optional) ‘abandonThreshold’: {{integer}} (optional) } Creates a single SLA by calling rest/create-sla-request with the provided data for current tenant. Optionally, it can create an active sla version by sending activeSla.

Possible Errors:

• Entities: 11097

CxEngage.entities.createSlaVersion({
  slaId: {{uuid}}, (required)
  versionName: {{string}} (required)
  description: {{string}} (optional)
  slaThreshold: {{integer}} (required)
  abandonType: {{string}} (required)
  abandonThreshold: {{integer}} (optional)
});

Creates new single SLA version by calling rest/create-sla-version-request with the provided data for current tenant.

Topic: cxengage/entities/create-sla-version-response

Possible Errors:

• Entities: 11102

CxEngage.entities.createTenant({
  name: {{string}} (required),
  adminUserId: {{uuid}} (required),
  parentId: {{uuid}} (required),
  regionId: {{uuid}} (required),
  timezone: {{string}} (required),
  active: {{boolean}} (required),
  description: {{string}} (optional),
});

Calls rest/create-tenant-request with the provided data for current tenant.

Topic: cxengage/entities/create-tenant-response

Possible Errors:

• Entities: 11117

CxEngage.entities.createTransferList({
  name: {{string}} (required),
  description: {{string}} (optional),
  active: {{boolean}} (required),
  endpoints: {{array}} (required)
});

Calls rest/create-transfer-list-request with the provided data for current tenant.

Topic: cxengage/entities/create-transfer-list-response

Possible Errors:

• Entities: 11107

CxEngage.entities.createUser({
  email: {{string}} (required),
  roleId: {{uuid}} (required),
  platformRoleId: {{uuid}} (required),
  defaultIdentityProvider: {{uuid}} (optional),
  noPassword: {{boolean}} (optional),
  status: {{string}} (required),
  workStationId: {{string}} (optional),
  externalId: {{string}} (optional),
  extensions: {{object}} (optional),
  firstName: {{string}} (optional),
  lastName: {{string}} (optional),
  capacityRuleId: {{uuid}} (optional)
});

Creates new single User by calling rest/create-user-request with the provided data for current tenant.

Topic: cxengage/entities/create-user-response

Possible Errors:

• Entities: 11065

CxEngage.entities.deleteException({
  businessHoursId: {{uuid}}, (required)
  exceptionId: {{uuid}} (required)
});

Removes single Exception by calling rest/delete-exception-request with the provided data for current tenant.

Topic: cxengage/entities/delete-exception-response

Possible Errors:

• Entities: 11088

CxEngage.entities.dissociate({
  originEntity: {
    name: {{string}}, (required)
    id: {{string}}, (required)
  },
  destinationEntity: {
    name: {{string}}, (required)
    id: {{string}}, (required)
  }
});

Dissociates item from the entity requested. For example , remove a user from a group or skill.

Topic: cxengage/entities/dissociate-response

Possible Errors:

• Entities: 11064

CxEngage.entities.getApikeys();

Retrieves available Api Keys configured for current logged in tenant

Topic: cxengage/entities/get-api-keys-response

Possible Errors:

• Entities: 11119

CxEngage.entities.getBusinessHour({
  businessHourId: {{uuid}}
});

Retrieves single Business Hour rule given parameter businessHourId as a unique key

Topic: cxengage/entities/get-business-hour-response

Possible Errors:

• Entities: 11121

CxEngage.entities.getBusinessHours();

Retrieves Business Hours configuration for current logged in tenant Topic: cxengage/entities/get-business-hours-response Possible Errors: - Entities: 11120

CxEngage.entities.getCapacityRules();

Retrieves available CapacityRules for current logged in tenant

Possible Errors:

• Entities: 11046

CxEngage.entities.getDashboards();

Retrieves available Custom Dashboards created for current logged in tenant

Topic: cxengage/entities/get-dashboards-response

Possible Errors:

• Entities: 11008

CxEngage.entities.getDataAccessMember({
  dataAccessMemberId: {{uuid}}
});

Retrieves single Data Access Member given parameter dataAccessMemberId as a unique key

Topic: cxengage/entities/get-data-access-member-response

Possible Errors:

• Entities: 11067

CxEngage.entities.getDataAccessReport({
  dataAccessReportId: {{uuid}}
});

Retrieves single Data Access Report given parameter dataAccessReportId as a unique key

Topic: cxengage/entities/get-data-access-report-response

Possible Errors:

• Entities: 11054

CxEngage.entities.getDataAccessReports();

Retrieves available Data Access Reports configured for current logged in tenant

Topic: cxengage/entities/get-data-access-reports-response

Possible Errors:

• Entities: 11053

CxEngage.entities.getDispatchMapping({
  dispatchMappingId: {{uuid}} (required),
});

Calls rest/get-dispatch-mapping-request with the provided data for current tenant.

Topic: cxengage/entities/get-dispatch-mapping-response

Possible Errors:

• Entities: 11094

CxEngage.entities.getDispatchMappings();

Calls rest/get-dispatch-mappings-request with the provided data for current tenant.

Topic: cxengage/entities/get-dispatch-mappings-response

Possible Errors:

• Entities: 11093

CxEngage.entities.getDisposition({
     disposition-id: {{uuid}} (required),
});

Calls rest/get-disposition-request with the provided data for current tenant.

Topic: cxengage/entities/get-disposition-response

Possible Errors:

• Entities: 11090

CxEngage.entities.getDispositions();

Retrieves available Dispositions configured for current logged in tenant

Topic: cxengage/entities/get-dispositions-response

Possible Errors:

• Entities: 11089

A generic method of retrieving an entity. The first way to call the function allows you to explicitly pass an entity name, or its name and it’s id along with an optional sub entity name.

CxEngage.entities.getEntity({
  entityName: {{string}} (required)
  entityId: {{uuid}} (optional)
  subEntityName: {{string}} (optional)
  stringifyKeys: {{boolean}} (optional)
  customTopic: {{string}} (optional)
});

Advanced users/consumers of the sdk/api can pass in an object with path as the key and an ordered array of the variables required to construct the api endpoint

CxEngage.entities.getEntity({
  path: {{array}} (required) Example Array ['groups', '0000-0000-0000-0000', 'outboundIdentifierLists']
  stringifyKeys: {{boolean}} (optional)
  customTopic: {{string}} (optional)
});

Retrieves an entity from the api matching the required parameters

Topic: cxengage/entities/get-entity-response

• Api Documentation

Possible Errors:

• Entities: 11068

CxEngage.entities.getFlow({
  flowId: {{uuid}},
  includeDrafts: {{boolean}} (optional)
});

Retrieves single Flow given parameter flowId as a unique key. Parameter includeDrafts indicates if drafts will be retrieved along the flow data and its versions.

Topic: cxengage/entities/get-flow-response

Possible Errors:

• Entities: 11084

CxEngage.entities.getFlows({
  includeNotations: {{boolean}} (optional)
});

Retrieves available Flows configured for current logged in tenant. Receives include-notations param to add flows that don’t belong to current tenant. Flows included are notations used in flow designer iframe.

Topic: cxengage/entities/get-flows-response

Possible Errors:

• Entities: 11043

CxEngage.entities.getGroup({
  groupId: {{uuid}}
});

Retrieves single Group given parameter groupId as a unique key

Topic: cxengage/entities/get-group-response

Possible Errors:

• Entities: 11060

CxEngage.entities.getGroups();

Retrieves available Groups configured for current logged in tenant

Topic: cxengage/entities/get-groups-response

Possible Errors:

• Entities: 11025

CxEngage.entities.getHistoricalReportFolders();

Retrieves available Report Types configured for current logged in tenant

Topic: cxengage/entities/get-historical-report-folders-response

Possible Errors:

• Entities: 11052

CxEngage.entities.getIdentityProviders();

Retrieves tenants configured single sign on identity providers

Possible Errors:

• Entities: 11073

CxEngage.entities.getIntegration({
  integrationId: {{uuid}} (required),
});

Retrieves a single Integration by calling rest/get-integration-request with integrationId as the unique key.

Topic: cxengage/entities/get-integration-response

Possible Errors:

• Entities: 11109

CxEngage.entities.getIntegrationListener({
  integrationId: {{uuid}} (required),
  listenerId: {{uuid}} (required)
});

Updates a single Listener by calling rest/get-integration-listener-request with listenerId as the unique key.

Topic: cxengage/entities/get-integration-listener-response

Possible Errors:

• Entities: 11113

CxEngage.entities.getIntegrationListeners({
  integrationId: {{uuid}} (required),
});

Retrieves available Listeners for current logged in tenant

Possible Errors:

• Entities: 11112

CxEngage.entities.getIntegrations();

Retrieves available Integrations for current logged in tenant

Possible Errors:

• Entities: 11045

CxEngage.entities.getMessageTemplate();

Retrieves specific message template data for current logged in tenant

Possible Errors:

• Entities: 11123

CxEngage.entities.getMessageTemplates();

Retrieves available message templates for current logged in tenant

Possible Errors:

• Entities: 11070

CxEngage.entities.getPermissions();

Retrieves Permissions for current logged in tenant

Possible Errors:

• Entities: 11049

CxEngage.entities.getPlatformRoles();

Retrieves available platform roles predefined for current logged

Possible Errors:

• Entities: 11063

CxEngage.entities.getPlatformUser(
  userId: {{uuid}} (required)
);

Retrieves specified platform user details

Possible Errors:

• Entities: 11072

CxEngage.entities.getPlatformUserEmail({
  email: {{email}}
});

Retrieves single User given email parameter

Topic: cxengage/entities/get-platform-user-email-response

Possible Errors:

• Entities: 11076

CxEngage.entities.getQueue({
  queueId: {{uuid}}
});

Retrieves single queue given parameter queueId as a unique key

Topic: cxengage/entities/get-queue-response

Possible Errors:

• Entities: 11002

CxEngage.entities.getReason({
  reasonId: {{uuid}}
});

Retrieves single Reason given parameter reasonId as a unique key

Topic: cxengage/entities/get-reason-response

Possible Errors:

• Entities: 11082

CxEngage.entities.getReasonList({
  reasonListId: {{uuid}}
});

Retrieves single Reason List given parameter reasonListId as a unique key

Topic: cxengage/entities/get-reason-list-response

Possible Errors:

• Entities: 11083

CxEngage.entities.getReasonLists();

Retrieves available ReasonLists for current logged in tenant

Possible Errors:

• Entities: 11048

CxEngage.entities.getReasons();

Retrieves available Presence Reasons for current logged in tenant

Possible Errors:

• Entities: 11047

CxEngage.entities.getRecordings({
  interactionId: {{uuid}}, (required)
  tenantId: {{uuid}} (optional)
});

Fetches a list of all recordings for the provided interaction-id

Topic: cxengage/entities/get-recordings

Possible Errors:

• [Entities: 11027](/cxengage-javascript-sdk.domain.errors.html#var-failed-to-get-artifacts-err
• [Entities: 11137](/cxengage-javascript-sdk.domain.errors.html#var-failed-to-get-recordings-err

CxEngage.entities.getRegions();

Retrieves regions that CxEngage platform can handle Topic: cxengage/entities/get-regions-response Possible Errors: - Entities: 11142

CxEngage.entities.getRole({
  roleId: {{uuid}}
});

Retrieves single Role given parameter roleId as a unique key

Topic: cxengage/entities/get-role-response

Possible Errors:

• Entities: 11079

CxEngage.entities.getRoles();

Retrieves available roles for current logged in tenant

Possible Errors:

• Entities: 11044

CxEngage.entities.getSkill({
  skillId: {{uuid}}
});

Retrieves single Skill given parameter skillId as a unique key

Topic: cxengage/entities/get-skill-response

Possible Errors:

• Entities: 11057

CxEngage.entities.getSkills();

Retrieves available Skills configured for current logged in tenant

Topic: cxengage/entities/get-skills-response

Possible Errors:

• Entities: 11026

CxEngage.entities.getSla({
  slaId: {{uuid}}
});

Retrieves single SLA given parameter slaId as a unique key

Possible Errors:

• Entities: 11104

CxEngage.entities.getSlas();

Retrieves available SLA configured for current logged in tenant

Possible Errors:

• Entities: 11103

CxEngage.entities.getTenant({
  tenantId: {{uuid}}
});

Retrieves single tenant given parameter tenantId as a unique key

Topic: cxengage/entities/get-tenant-response

Possible Errors:

• Entities: 2010

CxEngage.entities.getTenants({
});

Retrieves single Tenant information given parameter tenantId as a unique key Topic: cxengage/entities/get-tenants-response Possible Errors: - Entities: 11118

CxEngage.entities.getTimezones();

Retrieves timezones that CxEngage platform can handle Topic: cxengage/entities/get-timezones-response Possible Errors: - Entities: 11122

CxEngage.entities.getUser({
  resourceId: {{uuid}}
});

Retrieves single User given parameter resourceId as a unique key

Topic: cxengage/entities/get-user-response

Possible Errors:

• Entities: 11000

CxEngage.entities.getUserOutboundIdentifierLists(
  userId: {{uuid}}, (Optional, defaults to current user)
);

Retrieves the outbound identifier lists configured for currently logged in user

Possible Errors:

• Entities: 11068

CxEngage.entities.getUsers();

Retrieves available users for current logged in tenant

Topic: cxengage/entities/get-users-response

Possible Errors:

• Entities: 11001

CxEngage.entities.inviteUser({
  email: {{string}} (required),
  roleId: {{uuid}} (required),
  defaultIdentityProvider: {{uuid}} (optional),
  noPassword: {{boolean}} (optional),
  status: {{string}} (required),
  workStationId: {{string}} (optional),
  externalId: {{string}} (optional),
  extensions: {{object}} (optional),
  firstName: {{string}} (optional),
  lastName: {{string}} (optional),
  capacityRuleId: {{uuid}} (optional)
});

Invite new single User by calling rest/invite-user-request with the provided data for current tenant.

Topic: cxengage/entities/invite-user-response

Possible Errors:

• Entities: 11065

CxEngage.entities.removeFlowDraft({
  flowId: {{uuid}}, (required)
  draftId: {{uuid}} (required)
});

Removes single Flow Draft by calling rest/remove-flow-draft-request with the provided data for current tenant.

Topic: cxengage/entities/remove-flow-draft-response

Possible Errors:

• Entities: 11088

CxEngage.entities.updateApiKey({
  tokenId: {{uuid}},
  name: {{string}}, (optional)
  description: {{string}}, (optional)
  role-id: {{boolean}} (optional)
});

Updates a single Api Key by calling rest/update-api-key-request with the new data and groupId as the unique key.

Topic: cxengage/entities/update-api-key-response

Possible Errors:

• Entities: 11062

CxEngage.entities.updateBranding({
  tenantId: {{uuid}}, (required)
  styles: {{string}}, (optional),
  logo: {{string}}, (optional)
  favicon: {{string}}, (optional)
});

Updates tenants branding by calling rest/update-branding-request with the provided styles for the current tenant.

Topic: cxengage/entities/update-branding-response

Possible Errors:

• Entities: 11141

CxEngage.entities.updateBusinessHour({
  businessHourId: {{string}} (required),
  name: {{string}} (optional),
  timezone: {{string}} (optional),
  description: {{string}} (optional),
  active: {{boolean}} (optional),
  timeMinutes: {
    monStartTimeMinutes: {{integer}} (required, between 0 and 1440),
    monEndTimeMinutes: {{integer}} (required, between 0 and 1440),
    ...
    sunStartTimeMinutes: {{integer}} (required, between 0 and 1440),
    sunEndTimeMinutes: {{integer}} (required, between 0 and 1440),
  } (optional)
  exceptions: [
    {
      isAllDay: {{boolean}} (required),
      date: {{Date}} (required),
      startTimeMinutes: {{integer}} (required, between 0 and 1440),
      endTimeMinutes: {{integer}} (required, between 0 and 1440),
    }
  ] (optional)
});

Calls rest/update-business-hour-request with the provided data for current tenant.

Topic: cxengage/entities/update-business-hours-response

Possible Errors:

• Entities: 11130

CxEngage.entities.updateDataAccessReport({
  dataAccessReportId: {{uuid}},
  name: {{string}}, (optional)
  description: {{string}}, (optional)
  active: {{boolean}}, (optional)
  realtimeReportId: {{uuid}}, (optional)
  reportType: {{string}}, (optional)
  realtimeReportType: {{string}}, (optional)
  realtimeReportName: {{string}}, (optional)
  historicalCatalogName: {{string}}, (optional)
  users: {{array}} (optional)
});

Updates a single Data Access Report by calling rest/update-data-access-report-request with the new data and dataAccessReportId as the unique key.

Topic: cxengage/entities/update-data-access-report-response

Possible Errors:

• Entities: 11056

CxEngage.entities.updateDispatchMapping({
  dispatchMappingId: {{uuid}} (required),
  name: {{string}} (optional),
  description: {{string}} (optional),
  value: {{string}} (optional),
  flowId: {{uuid}} (optional),
  version: {{uuid || nil}} (optional),
  interactionField: {{string}} (optional),
  channelType: {{string}} (optional),
  active: {{boolean}} (optional),
});

Calls rest/update-dispatch-mapping-request with the provided data for current tenant.

Topic: cxengage/entities/update-dispatch-mapping-response

Possible Errors:

• Entities: 11096

CxEngage.entities.updateDisposition({
  dispositionId: {{uuid}} (required),
  name: {{string}} (required),
  description: {{string}} (optional),
  externalId: {{string}} (optional),
  active: {{boolean}} (required),
  shared: {{boolean}} (required),
});

Calls rest/update-disposition-request with the provided data for current tenant.

Topic: cxengage/entities/update-disposition-response

Possible Errors:

• Entities: 11092

CxEngage.entities.updateDispositionList({
      dispositionListId: {{uuid}} (required),
      name: {{string}} (optional),
      description: {{string}} (optional),
      externalId: {{string}} (optional),
      active: {{boolean}} (optional),
      shared: {{boolean}} (optional),
      dispositions: {{object}} (optional)
    });

Calls rest/update-disposition-list-request with the provided data for current tenant.

Topic: cxengage/entities/update-disposition-list-response

Possible Errors:

• Entities: 11139

CxEngage.entities.updateFlow({
  flowId: {{uuid}}, (required)
  flowType: {{string}}, (optional)
  name: {{string}}, (optional)
  activeVersion: {{uuid}}, (optional)
  active: {{boolean}}, (optional)
  description: {{string}} (optional)
});

Updates new single Flow by calling rest/update-flow-request with the provided data for current tenant.

Topic: cxengage/entities/update-flow-response

Possible Errors:

• Entities: 11087

CxEngage.entities.updateGroup({
  groupId: {{uuid}},
  name: {{string}}, (optional)
  description: {{string}}, (optional)
  active: {{boolean}} (optional)
});

Updates a single Group by calling rest/update-group-request with the new data and groupId as the unique key.

Topic: cxengage/entities/update-group-response

Possible Errors:

• Entities: 11062

CxEngage.entities.updateIntegration({
  integrationId: {{uuid}} (required)
  name: {{string}} (optional),
  description: {{string}} (optional),
  active: {{boolean}} (optional),
  properties: {{object}} (optional)
});

Calls rest/update-integration-request with the provided data for current tenant.

Topic: cxengage/entities/update-integration-response Possible Errors:

• Entities: 11111

CxEngage.entities.updateIntegrationListener({
  integrationId: {{uuid}} (required),
  listenerId: {{uuid}} (required)
  name: {{string}} (optional),
  active: {{boolean}} (optional),
  properties: {{object}} (optional)
});

Creates new single Integration Listener by calling rest/update-integration-listener-request with the provided data for current tenant. Topic: cxengage/entities/update-integration-listener-response Possible Errors: - Entities: 11115

CxEngage.entities.updateListItem({
  listId: {{uuid}},
  listItemKey: {{string}}
  itemValue: {{object}}
});

Updates single Generic List by calling rest/update-list-item-request with the provided data for current tenant.

NOTE: Within the individual item object assigned to the itemValue property, if you make a change to the item property that is serving as the key for the item (ie: the first field in that list), then you will get an error. Due to messiness of executing 2 API calls in a single SDK method, the temporary workaround () for this is to: 1) Delete the item using CxEngage.entities.deleteItem() 2) In the callback for the deleteItem() method, create a new item using the item object you want to create

Topic: cxengage/entities/update-list-item-response

Possible Errors:

• Entities: 11015

CxEngage.entities.updateMessageTemplate({
  messageTemplateId: {{uuid}} (required),
  name: {{string}} (optional),
  description: {{string}} (optional),
  channels: {{array}} (optional),
  templateTextType: {{string}} (optional),
  template:{{string}} (optional),
  active: {{boolean}} (optional),
});

Calls rest/update-message-template-request with the provided data for current tenant.

Topic: cxengage/entities/update-message-template-response Possible Errors:

• Entities: 11125

CxEngage.entities.updateOutboundIdentifier({
  id: {{uuid}}
  name: {{string}} (optional)
  active: {{boolean}} (optional)
  value: {{string}} (optional)
  flowId: {{string}} (optional)
  channelType: {{string}} (optional)
  description: {{string}} (optional)
});

Updates single Outbound Identifier by calling rest/update-outbound-identifier-request with the provided data for current tenant.

Topic: cxengage/entities/update-outbound-identifier-response

Possible Errors:

• Entities: 11032

javascript CxEngage.entities.updatePlatformUser({ userId: {{uuid}} (required), updateBody: {{object}} (required) });

Example updateBody updateBody: { ‘externalId’: {{string}} (optional) ‘firstName’: {{string}} (optional) ‘lastName’: {{string}} (optional) ‘personalTelephone’: {{string}} (optional) }

Updates a platform user accounts details from the provided updateBody

Topic: cxengage/entities/update-user-response

Possible Errors:

• Entities: 11071

CxEngage.entities.updateReason({
     reasonId: {{uuid}} (required),
     name: {{string}} (optional),
     description: {{string}} (optional),
     externalId: {{string}} (optional),
     active: {{boolean}} (optional),
     shared: {{boolean}} (optional),
    });

Calls rest/update-reason-request with the provided data for current tenant.

Topic: cxengage/entities/update-reason-response

Possible Errors:

• Entities: 11077

CxEngage.entities.updateReasonList({
      reasonListId: {{uuid}} (required),
      name: {{string}} (optional),
      description: {{string}} (optional),
      externalId: {{string}} (optional),
      active: {{boolean}} (optional),
      shared: {{boolean}} (optional),
      reasons: {{object}} (optional),
      isDefault: {{boolean}} (optional),
    });

Calls rest/update-reason-list-request with the provided data for current tenant.

Topic: cxengage/entities/update-reason-list-response

Possible Errors:

• Entities: 11081

CxEngage.entities.updateRole({
  roleId: {{uuid}}
  name: {{string}},
  description: {{string}},
  permissions: {{array}}
  active: {{boolean}} (optional),
  shared: {{boolean}} (optional),
  tenantId: {{uuid}} (optional)
});

Updates specified Role

Possible Errors:

• Entities: 11051

CxEngage.entities.updateSkill({
  skillId: {{uuid}},
  name: {{string}}, (optional)
  description: {{string}}, (optional)
  active: {{boolean}}, (optional)
  hasProficiency: {{boolean}} (optional)
});

Updates a single Skill by calling rest/update-skill-request with the new data and skillId as the unique key.

Topic: cxengage/entities/update-skill-response

Possible Errors:

• Entities: 11059

CxEngage.entities.updateSla({
  slaId: {{uuid}},
  name: {{string}}, (optional)
  active: {{boolean}}, (optional)
  shared: {{boolean}}, (optional)
  description: {{string}}, (optional)
  activeVersion: {{uuid}} (optional),
});

Updates a single SLA by calling rest/update-sla-request with the new data and slaId as the unique key.

Possible Errors:

• Entities: 11105

CxEngage.entities.updateTenant({ 
  tenantId: {{uuid}} (required),
  name: {{string}} (optional),
  description: {{string}} (optional),
  adminUserId: {{uuid}} (optional),
  timezone: {{string}} (optional),
  outboundIntegrationId: {{uuid}} (optional),
  cxengageIdentityProvider: {{string}} (optional),
  defaultIdentityProvider: {{uuid}} (optional),
  defaultSlaId: {{uuid}} (optional),
  active: {{boolean}} (optional)
});

Calls rest/update-tenant-request with the provided data for current tenant. Topic: cxengage/entities/update-tenant-response Possible Errors: - Entities: 11116

CxEngage.entities.updateTransferList({
  transferListId: {{uuid}} (required),
  name: {{string}} (optional),
  description: {{string}} (optional),
  active: {{boolean}} (optional),
  endpoints: {{array}} (optional)
});

Calls rest/update-transfer-list-request with the provided data for current tenant.

Topic: cxengage/entities/update-transfer-list-response Possible Errors:

• Entities: 11108

CxEngage.entities.createUser({
  userId: {{uuid}} (required),
  email: {{string}} (required),
  roleId: {{uuid}} (required),
  platformRoleId: {{uuid}} (required),
  defaultIdentityProvider: {{uuid}} (optional),
  noPassword: {{boolean}} (optional),
  status: {{string}} (required),
  workStationId: {{string}} (optional),
  externalId: {{string}} (optional),
  extensions: {{object}} (optional),
  firstName: {{string}} (optional),
  lastName: {{string}} (optional),
  capacityRuleId: {{uuid}} (optional),
  updateBody: {{object}} (optional)
});

Updates new single User by calling rest/update-user-response with the provided data for current tenant.

Topic: cxengage/entities/update-user-response

Possible Errors:

• Entities: 11066

CxEngage.entities.updateUserSkillMember({
  userId: {{uuid}},
  skillId: {{uuid}},
  proficiency: {{integer}}
});

Updates proficiency for a skill of an especific user, by calling rest/update-user-skill-member-request with the new data and skillId as the unique key.

Topic: cxengage/entities/update-user-skill-member-response

Possible Errors:

• Entities: 11075

CxEngage.entities.updateUsersCapacityRule({
  userId: {{uuid}}, (required)
  capacityRuleId: {{uuid or null}}, (optional)
  effectiveCapacityRule: {{uuid or null}}, (optional)
});

Updates the users effective capacity rule.

Topic: cxengage/entities/update-users-capacity-rule-response

Possible Errors:

• Entities: 11074

CxEngage.entities.uploadBrandingImage({
  tenantId: {{uuid}}, (required)
  file: {{object}}, (required)
  image-type: {{string}}, (required)
});

uploads branding image by calling rest/upload-branding-image with the provided styles for the current tenant.

Topic: cxengage/entities/update-branding-response

Possible Errors:

• Entities: 11140