API Reference
Log In
API Reference

/carrierusers

post
https://api.dev.orbit.do/v5/carrierusers
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

carrieruser to create

string
required

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

string
required

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

string
required

The carrier user's full name.

string

The user's phone number in international E.164 format (e.g. +49…).

string
required

The carrier user's email address. Also the login identifier.

string
enum
required

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

Allowed:
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.

string
enum
required

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

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:
string
required
length ≥ 8

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

boolean
Defaults to true

Whether to email the new user a welcome / invite message (default true).

Responses

401

unauthorized

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?