Import agents to Inbox using CSV

(This feature is currently in beta. Please contact customer support to get access to the feature).

In this article, you will learn how to import users to Inbox using a CSV file.

Import users

Please follow these steps to successfully import users to Inbox:

  1. Download the sample CSV file.

  2. Add data to the file.

  3. Upload CSV to Inbox.

Download the sample CSV file

Please download this CSV file to get a headstart. Alternatively, you can create your own CSV file with the following mandatory headers:

  1. firstName

  2. lastName

  3. nickName

  4. role

  5. email

  6. languages

  7. skills

  8. platforms

Add data to the file

Once you have the CSV file ready, please fill it with the user data. The table below shows an overview of data:

Header

Description

Required

Example

firstName

User’s first name.

Yes

Jane

lastName

Users’ last name.

Yes

Doe

nickName

User’s nickname for Inbox.

No

Jane

role

User’s role in Inbox. Agent of Admin

Yes

agent

email

User’s email address.

Yes

jane.doe@example.com

languages

Languages assigned to the user.

No

en:10

skills

Skills assigned to the user.

No

support

platforms

Platforms assigned to the user.

No

whatsapp:10

Please review the following sections to learn more about assigning languages, skills, and platforms:

Upload CSV file to Inbox

When your CSV file is ready, head to the Inbox and upload the CSV file by following these steps:

  1. Head to Agents page in Inbox.

  2. Click on Import Agents.

  3. Upload the file.

Once the file is validated, the import process will start. You can close the modal after the upload. We will notify you by email once the process is complete.

Additional resources

Assigning languages to users

The format to add a language to a CSV row is language_locale:level.

  • language_locale is the language code. For example en for English. You can find a full list here.

  • the level is the language level for the user. Choose a value from 1 to 10.

To assign multiple languages, separate values with a semicolon (;).

Examples

  • en:10

  • el:5

  • en:10;nl:5

Assigning skills to users

The format to add skills is skill_name_in_inbox.

  • skill_name_in_inbox is the exact value of skills you create in Inbox.

To assign multiple skills, separate values with a semicolon (;).

Examples

  • support

  • finance

  • support;finance

Assigning platforms to users

The format to add a language to a CSV row is platform_code:level.

  • platform_code is MessageBird’s code for a platform. For example whatsapp. You can find a full list below.

  • the level is the language level for the user. Choose a value from 1 to 10.

To assign multiple platforms, separate values with a semicolon (;).

Examples

  • email:10

  • instagram:5

  • whatsapp:10;email:5

Platform Codes

SMS

WHATSAPP

FACEBOOK

TWITTER

LINE

EMAIL

EMAIL_FREEMIUM

TELEGRAM

WECHAT

WHATSAPP_SANDBOX

LIVECHAT

VIBER

GOOGLE_BUSINESS_MESSAGES

INSTAGRAM

Last updated