/carrierusers

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

carrieruser to create

carrierId

string

required

Id of the carrier (company) this user belongs to.

carrierTeamId

string

required

Id of the team (within the carrier) this user belongs to.

name

string

required

The carrier user's full name.

phone

string

The user's phone number in international E.164 format (e.g. +49…). Required when no email is given. The user also gets the login for this number unless another user already holds it; without an email that is rejected with 409.

string

The carrier user's email address; the user can log in with it. Optional when a phone number is given: the user then logs in with the phone number only.

status

string

enum

required

Directory status: whether the user is usable for assignment (Active) or not (Inactive).

Allowed:

roleId

string

required

Id of the role granted to the new account. Account/role-sensitive.

properties

object

Custom property values keyed by the tenant's PropertyDefinition id.

languageSetting

string

enum

required

The user's preferred language (ISO 639-1: "en", "de", "pl" or "ro").

Allowed:

nationality

array of strings

Driver nationalities as ISO 3166-1 alpha-3 country codes (e.g. "DEU").

nationality

extras

array of strings

Driver qualification flags (e.g. ForkliftLicense, CarrierUserADR) this user holds; gate dispatch eligibility.

extras

Allowed:

password

string

required

length ≥ 8

The new login's password (min 8 characters). A login account is always provisioned.

sendWelcomeEmail

boolean

Defaults to true

Whether to email the new user a welcome / invite message (default true). Ignored when no email is given.

Responses

401

unauthorized

409

The email address is already in use, or no email is given and another user already logs in with the phone number (internalCode PHONE_LOGIN_TAKEN).

Language

Credentials

Header

URL

Loading…

Response

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

application/json

200created carrieruser