Description
The User Details Upload feature lets you upload a CSV file containing user attributes, which can overwrite or merge with existing data pulled from Entra ID (formerly Azure Active Directory), Google Directory, or the User Details Editor. You can also export a CSV of your current user information. Data uploaded through a CSV file is not affected by synchronization with Microsoft or Google. The uploaded data will remain unchanged until you update it manually.
• The CSV export will not include any data synced from Entra ID (formerly Azure AD) or Google Directory. It will only contain information previously uploaded via CSV or entered through the User Details Editor.
• The CSV export will not contain group names or sort users by groups. It will only list the available indivudual user mailboxes and their relevant user details.
• When uploading a file containing special characters, the CSV must be saved as UTF-8 with BOM rather than standard UTF-8 to prevent character corruption.
• This feature is only available on Standard or Pro Plans. For more information on pricing plans, see Exclaimer pricing plans.
How to access it
To access User Details Upload:
- From the header bar, select the cogwheel icon to open the Settings menu, then select Sender Management.
- Navigate to the User Details Upload section.
Using the User Details Upload
You can upload a CSV to completely replace any existing data with only what is in the CSV, or you can upload a CSV to update or add to existing data.
• Only users with the Owner or Admin role can use this feature. For more information on roles and permissions, see User Management.
• You cannot add or remove users using this feature. To update user access, you will need to clear the CSV file and re-enable the sync to add or remove users from Google or Microsoft Entra ID.
Select an option below to view the related instructions:
This removes all current user data, including any data updated by individual users via the User Details Editor, and replaces it with the data in the CSV you upload.
To overwrite the CSV file:
- Create or edit your CSV file to contain all relevant users and user details. Confirm that your CSV meets the following requirements for validation rules:
- The CSV must contain only individual users. You cannot import groups, group memberships, and domains.
- The first CSV column must be Email.
- Column headers must have no spaces between words, and each word must start with a capital letter. For example, 'Sample column header' must be written as 'SampleColumnHeader'. This is also known as camel case format and is necessary for Exclaimer to format your header names correctly. Spacing will appear normally when the data is viewed in the User Details Editor.
- The only special characters allowed in column headers are '.' and '-'. All other characters in column headers must be alphanumeric.
- Max file size: 150MB
- Max Columns: 100
- Max Field Length: 255
- Max Value Length: 256
- [Optional] The User ID can be specified as ID or ObjectID. If it is not specified, then Email will be used instead.
- [Optional] The Display Name can be specified as DisplayName or FullName. If it is not specified, then Email will be used instead.
- In the User Details Upload, select Overwrite All.
- Select the Proceed with Overwrite All checkbox to confirm that you wish to continue.
- In the file explorer, locate and select your CSV file and select Open.
The Authorization in Progress message is displayed.
Once the overwrite all procedure has been successful, the Export Existing Successful message is displayed.
This adds new or extra data to the existing data. The new data in your CSV is merged with any existing data. If your CSV contains changes to existing data, only that data is overwritten.
To merge the CSV file:
-
Create or edit your CSV file to contain the relevant users and user details to update. Confirm that your CSV meets the following requirements for validation rules:
- The CSV must contain only individual users. You cannot import groups, group memberships, and domains.
- The first CSV column must be Email.
- Column headers must match the column headers for your existing data. Any mismatches will be treated as new columns.
- Column headers must have no spaces between words, and each word must start with a capital letter. For example, 'Sample column header' must be written as 'SampleColumnHeader'. This is also known as camel case format and is necessary for Exclaimer to format your header names correctly. Spacing will appear normally when the data is viewed in the User Details Editor.
- The only special characters allowed in column headers are '.' and '-'. All other characters in column headers must be alphanumeric.
- Max file size: 150MB
- Max Columns: 100
- Max Field Length: 255
- Max Value Length: 256
- [Optional] The User ID can be specified as ID or ObjectID. If it is not specified, then Email will be used instead.
- [Optional] The Display Name can be specified as DisplayName or FullName. If it is not specified, then Email will be used instead.
Tip! When creating a CSV to merge, you can include only the users and details that need updating as long as the above validation rules are still followed. - Select Update Existing to import a CSV file.
The Open window is displayed.
- In the file explorer, locate and select your CSV file, then select Open.
The Authorization in Progress message is displayed.
Once the update existing procedure has been successful, the Update Existing Successful message is displayed.
This exports current user data to a CSV file.
To export user data:
- Select Export Existing. The CSV file is downloaded to your device.