post https://api.repsly.com/v3/import/user
Endpoint is used to import users from your system into Repsly.
Request definition
Required keys are marked with a red triangle 🔺
| Name | Type | Description |
|---|---|---|
| Code🔺 | String (20) | ID |
| Name🔺 | String (80) | Name |
| Email🔺 | String (100) | |
| Active | Boolean | Is user active |
| Role | String (80) | Roles, pipe separated (AccountOwner|Admin|Representative) |
| Note | String (255) | Note |
| Phone | String (128) | Phone |
| Territories | Array(String) | The array of strings of territory paths that user is associated with. Territory path is representation of hierarchical territory position as territory names separated by “/”. Ex. “Territory 1/Territory 1.1/Territory 1.1.1” |
| SendEmailEnabled | Boolean | User is allowed to send emails from mobile app |
| Address1 | String (256) | Address1 |
| Address2 | String (256) | Address2 |
| City | String (256) | City |
| State | String (256) | State |
| ZipCode | String (20) | ZIP |
| ZipCodeExt | String (20) | ZIP ext |
| Country | String (256) | Country |
| CountryCode | String (20) | Country code |
| Attributes | Array(Attribute) | List of attributes with values and types specified for that company. |
| Permissions | Array(String) | List of admin permissions |
Attribute array definition
| Name | Type | Description |
|---|---|---|
| Title🔺 | String | Name of the attribute (defined by the admin). |
| Value🔺 | String | The value set for that user. If the value is null than the value is not set. |
Response definition
| Name | Type | Description |
|---|---|---|
| Code | Integer | Error identifier (0 = no errors) |
| Message | String (255) | Response affirmative or error message |
| Value | String | The value set for that user. If the value is null than the value is not set. |
| Summary\CurrentUsersActive | Integer | Number of active users before import. |
| Summary\NewUsersActive | Integer | Number of active users after import. |
| Summary\RowsTotal | Integer | Number of affected records (users) during import. |
| Summary\RowsInsert | Integer | Number of new users inserted during import. |
| Summary\RowsUpdate | Integer | Number of updated existing users during import. |
| Summary\RowsInvalid | Integer | Number of records with invalid data submitted. |
| Summary\ValidationErrors | Dictionary(String,Array(String)) | All import validation errors grouped by user identifier. |
In case of a HTTP bad request (code 400), you will also receive a status response with Code equal to 1 and an error message.