Create User

POST 
/users/

Create User

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

companyIdstringrequired

Company/Agency ID to associate the user with

emailstringrequired

Email address of the user (used for login)

passwordstringrequired
Password for the user account. All passwords will be required to meet the following criteria:
• Minimum 12 characters
• At least one uppercase letter (A–Z)
• At least one lowercase letter (a–z)
• At least one number (0–9)
• At least one special character (e.g., !, @, #, $)
phonestring

Phone number of the user in E.164 format

typestringrequired

User account type (account for sub-account users, agency for agency-level users)

rolestringrequired

User role within the account (admin or user)

locationIdsstring[]required

List of location IDs to assign to the user

permissionsobject

User permissions controlling access to various features

scopesstring[]
Scopes allowed for users. Only scopes that have been passed will be enabled. Note:- If passed empty all the scopes will be get disabled
Available optionscampaigns.readonlycampaigns.writecalendars.readonlycalendars/events.writecalendars/groups.writecalendars.writecontacts.writecontacts/bulkActions.writeworkflows.readonlyworkflows.writetriggers.writefunnels.write
scopesAssignedToOnlystring[]
Assigned Scopes allowed for users. Only scopes that have been passed will be enabled. If passed empty all the assigned scopes will be get disabled
Available optionscampaigns.readonlycampaigns.writecalendars.readonlycalendars/events.writecalendars/groups.writecalendars.writecontacts.writecontacts/bulkActions.writeworkflows.readonlyworkflows.writetriggers.writefunnels.write
profilePhotostring

URL of the user profile photo

twilioPhoneobject

Per-location inbound Twilio number in E.164 format, keyed by location id (Call and Voicemail Inbound Number for direct Twilio, not LC Phone). Replacement semantics: if you send twilioPhone in the request body, the stored map is replaced entirely with this object (not merged). Any location id omitted from the object is removed from the saved map. Omit the twilioPhone property entirely to leave existing numbers unchanged. Send an empty object {} to clear all per-location numbers. To clear a single location only, set that location id to an empty string "".

platformLanguagestring
Platform language preference for the user
Available optionsen_USesfr_CAfr_FRnldept_PTpt_BRitsvdafi
firstNamestringrequired

First name of the user

lastNamestringrequired

Last name of the user

Example (auto)

{
  "companyId": "ve9EPM428h8vShlRW1KT",
  "email": "[email protected]",
  "password": "************",
  "phone": "+18832327657",
  "type": "account",
  "role": "admin",
  "locationIds": [
    "C2QujeCh8ZnC7al2InWR"
  ],
  "permissions": {
    "campaignsEnabled": true,
    "campaignsReadOnly": false,
    "contactsEnabled": true,
    "workflowsEnabled": true
  },
  "scopes": [
    "contacts.write",
    "campaigns.readonly"
  ],
  "scopesAssignedToOnly": [
    "contacts.write",
    "campaigns.readonly"
  ],
  "profilePhoto": "https://img.png",
  "twilioPhone": {
    "C2QujeCh8ZnC7al2InWR": "+18832327657",
    "M2QrtfVt8ZnC7cv2InDL": "+18832327657"
  },
  "platformLanguage": "en_US",
  "firstName": "John",
  "lastName": "Deo"
}

application/json

Successful response

application/json

Schema

Schema

idstring

Unique identifier of the user

namestring

Full name of the user

firstNamestring

First name of the user

lastNamestring

Last name of the user

emailstring

Email address of the user

phonestring

Phone number of the user

extensionstring

Phone extension of the user

permissionsobject

User permissions controlling access to various features

scopesstring
List of OAuth scopes granted to this user
Available optionscampaigns.readonlycampaigns.writecalendars.readonlycalendars/events.writecalendars/groups.writecalendars.writecontacts.writecontacts/bulkActions.writeworkflows.readonlyworkflows.writetriggers.writefunnels.write
rolesobject

Role and access configuration for the user

lcPhoneobject

LC Phone Inbound Phone Numbers

platformLanguagestring
Platform language preference for the user
Available optionsen_USesfr_CAfr_FRnldept_PTpt_BRitsvdafi

Example (auto)

{
  "id": "0IHuJvc2ofPAAA8GzTRi",
  "name": "John Deo",
  "firstName": "John",
  "lastName": "Deo",
  "email": "[email protected]",
  "phone": "+1 808-868-8888",
  "extension": "",
  "permissions": {
    "campaignsEnabled": true,
    "campaignsReadOnly": false,
    "contactsEnabled": true,
    "workflowsEnabled": true
  },
  "scopes": [
    "contacts.write",
    "campaigns.readonly"
  ],
  "roles": {
    "type": "account",
    "role": "admin",
    "locationIds": [
      "ve9EPM428h8vShlRW1KT"
    ]
  },
  "lcPhone": {
    "locationId": "+1234556677"
  },
  "platformLanguage": "en_US"
}