Business Data API

1. Set up permissions

   Make sure you have the appropriate permissions enabled in Admin > Security > Roles and Permissions to use the Business Data Update API.

   • Access keys:

     • If you're generating access keys for other users, then you need the Admin > General Permissions > Access Key: Create permission.

     • If you're generating access keys from your own user, then you need the Admin > General Permissions > My Access Key: Create permission.

   • Entity:

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

2. Follow the below steps to generate an access token.

   To use these APIs, you must first generate an access token (to be used as an authorization bearer token when calling the Business Data APIs).

   1. Go to CXone.

   2. Click the app selector and select Admin.

   3. Click Employees.

   4. Select the user you're going to generate the access key for.

   5. Go to the Access Keys tab and generate an access key.

   6. Copy both the Access Key ID and Secret Access Key and save them somewhere safe. If you don't copy the Secret Access Key or if you lose it, you'll need to create a new one.

   7. Call this API:

      URL: https://<enter your region, this is the subdomain (first 3 characters) of the CXone URL (for example: na1, na2, au1, eu1)>.nice-incontact.com/authentication/v1/token/access-key

      Type: POST

      Request body:

      {

           "accessKeyId": <access key>,

           "accessKeySecret": <secret>

      }

   8. Extract the access_token from the response body. Use this string as a bearer token authorization header when calling the Business Data API.

   9. Verify the entity permissions—checks are applied and may result in success or unauthorized.

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

Type: PUT

[
 {
  "business_data_name1": "text"
 },
 {
  "business_data_name2": "true/false",
 },
 {
  "business_data_name3": "numeric",
 }
] 

Response

• Status 204 - Success.

• Status 400 - Invalid request. Incorrect date filters, etc.

• Status 401 - Unauthorized. Invalid credentials.

• Status 403 - Forbidden.

• Status 404 - Not Found.

• Status 500 - Internal Server Error.