You are here:
Create Or Update Contact Center Users in Bulk
Use Salesforce Bulk APIs to add contact center users in bulk. You can use this bulk operation if you want to add or update more than 100 users at a time.
Required Editions
This article applies to:
- Salesforce Voice with Amazon Connect
- Salesforce Voice with Partner Telephony from Amazon Connect (also applies to Voice manually integrated with your Amazon Connect instance by importing the contact center definition XML file)
- Salesforce Voice with Partner Telephony
| View supported editions. |
-
Create a CSV file with the required fields, and add the user records.
-
If you use the Salesforce Voice with Amazon Connect or Salesforce Voice with Partner
Telephony from Amazon Connect license, then create a CSV file with the fields:
Argument1: Add the email ID of the user.
Argument2: Add the user ID in this field. The user ID must be 18 characters, and use your preferred method to fetch it from the Id column of the User table.
Argument3: Add the profile of the user. This is a case-sensitive field, and the only possible values are Admin, Agent, and CallCenterManager.
Argument4: Add the routing profile ARN in your Amazon Connect account.
Argument5: Add the contact center ID.
BulkAction: The value for this field must be
AddUsers.An example CSV file is available in Github.
-
If you use the Salesforce Voice with Partner Telephony icense, then create a CSV file
with the fields:
Argument1: Add the email ID of the user.
Argument2: Add the user ID in this field. The user ID must be 18 characters, and use your preferred method to fetch it from the Id column of the User table.
Argument5: Add the contact center ID.
BulkAction: The value for this field must be
AddUsers.In this case, the Partner Telephony Permission Set is alo automatically assigned to the user.
An example CSV file is available in Github.
-
If you use the Salesforce Voice with Amazon Connect or Salesforce Voice with Partner
Telephony from Amazon Connect license, then create a CSV file with the fields:
-
Follow the instructions in the Bulk API guide for using the bulk API to create a job,
upload job data, and complete the upload. Use your preferred method to trigger the
ContactCenterBulkOp entity, and upload the CSV file.
The fields of the ContactCenterBulkOp entity are:
Argument1: Mandatory field. This field represents the email ID of the user.
Argument2 : This field represents the user ID.
Argument3 : This field represents the profile of the user.
Argument4 : This field represents the routing profile ARN in your Amazon Connect account.
Argument5 : This field represents the contact center ID.
ErrorMessage : If an error occurs, this field indicates the error message. Otherwise, this field is blank.
Status : Indicates the status of the bulk action.
BulkAction: Mandatory field. Allowed value is
AddUsers.VoiceProvisioningJobID: This field represents the job ID.
You can add or update only the Argument1, Argument2, Argument3, Argument4, Argument5, and BulkAction fields. The remaining fields are read-only.
- Query the Status field to check the status of the bulk action. Refresh the Salesforce org and Amazon account to verify the new users added in the contact center.
When using Salesforce Bulk APIs to add or update contact center users in bulk, it's best to keep the maximum number of users per request at 5,000.
If an error occurs in the CSV file for one or more users, then the operation fails only for those users, and you can query the ErrorMessage field to see the error message.
You can also use the ContactCenterBulkOp entity to update the field values of a contact center user.
