External ID is an optional user field that cannot be set, updated, or removed in a user's profile in the agent interface. The easiest way to alter this field is through a bulk user import.
Conditions
SSO usually sets external IDs, but you can also set, update, or remove them using the API and user imports. You cannot merge users who have external IDs. Authentication conflicts may occur if a user's external ID and email do not match. In both situations, you need to remove or edit the user's external ID before you can continue. The simplest way to do this is to use the bulk user import tool.
Steps to follow
- In Google Sheets or a comparable program, create a spreadsheet with three columns titled
name
,email
, andexternal_id
. This must be typed out exactly as written - For each user that you want to edit, enter their name and email address as it is currently listed in their user profile
- If you want to remove that user's external ID, leave the third column blank. If you want to edit their external ID, enter the correct external ID in the third column
- Click File > Download as > Comma-separated values
- In the agent interface, open the Customers page. In the right sidebar, select Bulk user import.
- Under Select CSV file, select the file you just created
- Make sure the Update existing users and Include external IDs in import results file option is enabled
- Click Import
For more information on bulk updating users, see the article: How can I bulk update users?