API
View as Markdown

Invite a user

POSThttp://localhost:4000/api/users/inviteUser

Adds a person to your team and sends them an invitation email.

Your API key needs the users.MANAGE_ORG_USERS permission.

Body Params

emailstringrequired

Email address.

firstNamestringrequired

First name.

lastNamestring

Last name.

occupationRolestring

Job title.

countrystring

Country name.

genderstring

Gender.

timezonestring

Time zone.

languagestring

Language code.

phoneCountryCodestring

Two-letter country code of the phone number.

phoneDialCodeinteger

Dial code without the plus sign.

phoneinteger

National phone number, digits only.

hierarchyIdintegerrequired

ID of the team the user belongs to.

permissionsRoleIdintegerrequired

ID of the role of the user.

hasHierarchyDataAccessboolean

True when the user sees all the data of their team.

passwordstringrequired

A first password for the account. At least 8 characters, with upper and lower case letters, a number and one of @#$!^()%*?&.

brandsIdsarray of integerrequired

IDs of the brands the user can access.

Responses

200Successful response.
400The request is not valid.
401The API key is missing, invalid, expired or disabled.
403The API key does not have the permission this endpoint needs.