Verified AI summary ◀▼
Admins can bulk import user data using a CSV file to add or update user information, including roles and organization memberships. Before importing, ensure data imports are enabled and organizations are imported first. Note limitations like a 2,000-row maximum per file and the inability to import certain data types. Consider your welcome email settings to manage notifications for new users.
Zendesk recommends using the data importer to import user data instead of the legacy Bulk actions page described in this article. However, if you prefer, you can still use the Bulk actions page to import new or updated user information.
Admins can add many users in a bulk import rather than adding users manually one at a time. To do this, you create a comma-separated values (CSV) file that contains the user's data. In addition to essential user data, such as email address and phone number, you can also set user roles, define an agent's privileges, and add users to an organization. You can use bulk import to either add new users or update existing ones. Bulk import via a CSV file only works for Support users and roles.
You must be an administrator to bulk import users and organizations.
- To protect the data in your Zendesk account, data imports are not enabled by default. The account owner or an admin must contact Zendesk Customer Support to enable data exports and access to the imports page.
- If you want to bulk import both users and organizations, you must import organizations first.
Considerations for bulk importing users (legacy)
There are several limitations and considerations you should review before bulk importing users.
Limitations for bulk importing users and organizations (legacy)
You can import a core set of data about users and organizations. For example, you can import the data described in the table below. However, you can't import time zones, photos, language preferences, and other data. To import data not listed in the table below, you must use the Zendesk REST API instead. See Importing users with the Zendesk API or Importing organizations with the Zendesk API.
- When using the Bulk actions pages, the import CSV data file can contain a maximum of 2,000 rows. That is, one header row and up to 1,999 rows of data.
- Don't include the same user or organization more than once within a CSV file. Doing so can cause your import to fail.
- There's no guarantee that records are created or updated in the order they appear in the CSV file.
- You can only import one CSV file at a time. Therefore, if you have more data than the maximum number of rows supported for the CSV file, you must create separate files for each batch and import them one after another. When you're not using the data importer, up to two batches are queued and run in the background. If you want to import more than two batches, you need to wait until the first batches are finished importing to add more.
- You cannot use bulk importing to import contact information from end-user Facebook or X (formerly Twitter) accounts. Instead, use the Zendesk REST API. See Importing users with the Zendesk API.
How data is updated by the bulk actions import (legacy)
- name
- external_id
- role
- restriction
- organization
- custom fields
- tags (only when using the data importer)
- details
- notes
- tags
- phone (added as a secondary phone number)
- email (added as a secondary email address)
Deciding whether to send an email to users imported in bulk (legacy)
Before you perform a bulk import of users, it's important to check your welcome email settings. When you add new users via a bulk import while Guide is enabled, each user receives the welcome email message. The welcome email contains a link to verify their email address, which prompts them to select a password and then sign in. You can prevent the welcome email from being sent to these users.
To prevent the welcome email message being sent to users
- In Admin Center, click
People in the sidebar, then select Configuration > End users. - In the User welcome email section, deselect Also send a
verification email when a new user is created by an agent or
administrator.
- Click Save.
Creating the CSV user data file (legacy)
When you create a list of users to import, you'll probably generate this list from some other user management system, such as an employee database. Most of these systems have some facility for creating a CSV export file. If you need to create the list from scratch, you can use a program like Microsoft Excel or OpenOffice.org Calc.
- The file must be properly formatted CSV and saved using UTF-8 character encoding.
- The first row of the CSV file is the header row, and you must include it in the file.
- The header row must contain any required fields in the table below, plus any other fields listed in the table below that you want to include.
- Included fields must appear in the header row in the order they are listed below.
- If you are not importing data for a field, do not list it in the header row.
- Empty columns of data in the file will overwrite most existing data for that user. For exceptions, see How data is updated by the bulk actions import.
- Add line breaks to notes or multiline custom fields by pressing ALT+ENTER on Windows or CTRL+OPTION+RETURN on a Mac.
The following table lists the fields that you can include in the file. The name, email, and restriction fields are all required when importing new users. When existing users are updated via bulk import, only one unique identifier is required (such as an email or external ID).
| Field | Description |
|---|---|
| name | Required for importing new users. User's full name. |
| Required for importing new users. User's full email address (someuser@mycompany.com). The email field accepts a blank or empty value. If the email field is blank or empty, the system still creates the user profile. | |
| restriction |
Required for importing new users. Restriction sets the
team member's or end user's privileges, the tickets they have
access to, etc. This is required to import new users when the
user's role is set to Agent
On non-Enterprise plans, the following restriction values are
supported:
Restriction values of "organization" and
"requested" can be assigned when the user's role is set to
"End-user". All others apply only to team members.
Note: On Enterprise plans, agent roles
override the standard agent restrictions. This means that
you can't use any of the standard restrictions listed in the
table above to import or update an agent. You must specify
an agent role. If you accidentally use a role name that
doesn't exist in Support, the user's role defaults to Light
Agent.
|
| external_id | If you have an ID other than the user's email address (such
as an employee ID or customer reference number), you can include
it here. External IDs must be unique for each user, or data will
be overwritten. If you need to configure multiple email addresses or phone numbers for a single user, you can do so by creating multiple entries for the user in the CSV file and using the same external_id column for all rows you want associated with a single user. With the exception of the additional email or phone numbers, the values in all other columns should remain the same for each row. If any external ID, email address, or phone number matches more than one existing user, that row is rejected from the bulk import.
Note: If you import users
with the external_id field as their only identifier (meaning
you're not also including email address), you still need to
include the email field in the CSV file, with no data. For
example:
|
| details | Detailed information concerning this user, such as an address. This information is visible to team members only, not to end users. |
| notes | Notes concerning this user. Notes are visible to team members only, not to end users. |
| phone | The user's telephone numbers. Unique phone numbers are added as direct lines. Phone numbers that already exist are added as secondary lines. To work with Zendesk, phone numbers should be formatted with the internationally standardized E.164 format. |
| shared_phone_number | If this is a shared phone number, set to "true". A shared phone number cannot be used as a user identity. |
| role | Case sensitive: End-user, Agent, or Admin. If you don't set a role, the user is set to End-user. |
| organization | The name of the organization that the user will be added to.
The organization must already exist, or the import will fail.
On Professional and Enterprise plans, you can add a user
to multiple organizations by separating the organization
names with a pipe character. For example:
A user's default organization is set to the first organization alphabetically. It isn't possible to set a different default organization during a bulk import. However, the default organization for a user can be adjusted manually or with the Support API - Set Membership as Default endpoint. |
| tags | When user and organization tagging has been enabled for Zendesk Support (see Adding tags and users to organizations), you can add user tags. Separate each tag with a comma. |
| brand | If the account has multiple brands, you can specify a brand
subdomain. The brand subdomain you specify determines the brand
of the welcome email sent to the user, as long as that brand is
active and has an enabled help center. If the brand subdomain
you specify is not active, doesn't have an enabled help center,
or doesn't exist, the column is ignored, and the welcome email
is sent using the default brand. Brand subdomains are
case-sensitive and must be an exact match to be imported.
Specify only the name of the brand subdomain. For example, use mydomain and not mydomain.zendesk.com. |
| custom_fields.<field key> | When you perform a bulk user import, you can import a custom
user field by specifying the custom_fields. prefix and
the field key. For example, for the field key subscription_date, use the following to set the imported values for this field. custom_fields.subscription_date Note that custom field keys are case-sensitive and must be entered in lowercase letters. If you are importing information into a checkbox, enter 'true' to have it checked or 'false' to leave it unchecked. To set the value of drop-down list options, use the tag you added when you created the drop-down list. For custom date fields, use either the YY/MM/DD or YYYY-MM-DD format. To locate
the key for a custom user field:
If a field value is not formatted correctly, the import will fail, and you will receive an error report specifying which records failed to save.
Note: If the custom user field you're
importing is a lookup relationship
field, enter the ID of the related object as the
value for this field. For example, for an organization,
enter the organization's ID; for a user, enter the user's
ID; for a custom object record, enter the record's ID. To
find an organization, user, or custom object record ID, you
can export data from your
account or use the Organizations API,
Users API, or
Custom Object Records
API.
|
Using a bulk actions import to import user data (legacy)
Although Zendesk recommends using the data importer, you can still use the Bulk actions pages to import new and updated information for users.
- In Admin Center, click
People in the sidebar, then select Bulk actions > Import users.
- Select import options:
-
Create new users: This is selected by default and cannot be deselected. This is because users listed in the CSV file that don't exist in your Zendesk account are always created.
-
Update existing users: Select this import option if you also want to modify data for existing users.
An external_id or email address must be included in the CSV file for each user so that they can be identified. Other than user identification fields, only include the fields you want to update in your CSV file. If you don't enter a value for a field in your CSV file, that value is overwritten for the existing user.
If any external ID, email address, or phone number matches more than one existing user, that row is rejected from the bulk import.
Note: If you don't want to add new users, you must use the data importer. When using the Bulk actions pages, if your CSV file contains information about new users, they are always added, regardless of the import option you select. -
- (Optional) Select Include external ID in CSV output file.
When the import process is complete, you will receive an email notification that includes a link to a separate CSV import results file. Use this link to download the file and view the results of your import. The file shows the status of the user data that you attempted to import (Created, Updated, Failed, Unchanged). If you select this option, the report includes the email address or an external ID for each user that is created or updated.
If you don't select this option, external IDs are excluded from the CSV import results file. Instead, only the user's email address is listed for each user that is created or updated.
- Click one of the following: Choose File or Let me paste in data instead.
- Click Import.
Your import is added to the queue, and the users are added to Zendesk Support when the import process is complete. You'll receive an email when the import is complete.