Business Data API

Business data are custom fields that can be associated with the call's metadata. Using the Business Data API, you can update the values for the existing business data fields for any closed interactions. You cannot add new business data fields using this API. This API works alongside the MCR META DATA action in Studio. This action lets you send interaction data for a single contact during live interactions.

Documentation for the Business Data API is available in the Developer Community portal .

Before You Start

You can test NiCE CXone APIs on the developer portal . Log in with a NiCE CXone account, then you can make requests with your account's tenantClosed High-level organizational grouping used to manage technical support, billing, and global settings for your NiCE CXone system..

To start using the APIs, you must register with NiCE to receive valid credentials used for authentication. Review the Getting Started page on the developer portal for instructions.

Usage of these APIs requires the following permission:

Entity: To update the business data API, you need the Search & Playback > APIs > Update Business Data permission.

Update Business Data

For a closed interaction, update the existing business data field information for all the segments available for the given Omnichannel Routing (ACD) contactId.

Method: PUT

Endpoint: /business-data-manager/v1/business-data/contact/{ACD contactId}

Parameters:

contactId*:

string

Unique identifier of the Omnichannel Routing (ACD) contactId for which to update the business data values.

URL: https://na1.test.nice-incontact.com/business-data-manager/v1/business-data/contact/8675309

Type: PUT

[
 {
  "business_data_name1": "string of text"
 },
 {
  "business_data_name2": true,
 },
 {
  "business_data_name3": 1234,
 }
]

Response

  • Status 204 - The server has successfully fulfilled the request and that there is no additional content to send in the response payload body.

  • Status 400 -The request contained incorrect input parameters.

  • Status 401 - Authentication failure. Incorrect credentials.

  • Status 403 - Permissions required.

  • Status 404 - Requested contact was not found.

  • Status 500 - Internal Server Error.

Update Business Data

For a closed interaction, update the existing business data field information for the specified segment in the given Omnichannel Routing (ACD) contactId.

Method: PUT

Endpoint: /business-data-manager/v1/business-data/contact/{ACD contactId}/segment/{segmentId}

Parameters:

contactId*:

string

Unique identifier of the Omnichannel Routing (ACD) contactId that contains the segment with the business data values to be updated.

segmentId*:

string

Unique identifier of the Omnichannel Routing (ACD) contactId segment with the business data values to be updated.

URL: https://na1.test.nice-incontact.com/business-data-manager/v1/business-data/contact/{ACD contactId}/segment/b2e28d4e-ef22-4597-a104-2e740f729686

Type: PUT

[
 {
  "business_data_name1": "string of text"
 },
 {
  "business_data_name2": true,
 },
 {
  "business_data_name3": 8675309,
 }
]

Response

  • Status 204 - The server has successfully fulfilled the request and that there is no additional content to send in the response payload body.

  • Status 400 -The request contained incorrect input parameters.

  • Status 401 - Authentication failure. Incorrect credentials.

  • Status 403 - Permissions required.

  • Status 404 - Requested segment was not found.

  • Status 500 - Internal Server Error.