/carrierusers

post https://api-dev.orbit.do/v5/carrierusers

Body Params

carrieruser to create

carrierId

string

required

carrierTeamId

string

required

name

string

required

phone

string

required

status

string

required

roleId

string

required

properties

object

Key-value pairs in the dictionary have property IDs as keys. Property keys and their values appear only when the property value is explicitly set. The dictionary doesn't have default values, so retrieved property values are always undefined by default. Note: Data is stored even if the property definition doesn't exist. If there's no property definition, values won't be displayed on the frontend but can still be present in the dictionary.

languageSetting

string

required

nationality

array of strings

nationality

extras

array of strings

extras

password

string

required

length ≥ 8

sendWelcomeEmail

boolean

Defaults to true

Responses

401

unauthorized

Language

Credentials

Header

URL


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://api-dev.orbit.do/v5/carrierusers \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "status": "Active",
8
  "languageSetting": "en",
9
  "sendWelcomeEmail": true
10
}
11
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200created carrieruser