/shippers/{shipperId}/users

post

https://api.dev.orbit.do/v5/shippers/{shipperId}/users

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

shipperId

string

required

Body Params

shipperuser to create

firstName

string

required

length ≥ 1

The user's first name.

lastName

string

required

length ≥ 1

The user's last name.

phone

string

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

string

required

The user's email address. Also the login identifier when an account is created.

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. All property values are validated against their definitions - requests with unknown property IDs or invalid value types will be rejected with a 400 error.

shipperTeamId

string

required

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

languageSetting

string

enum

required

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

Allowed:

createAccount

boolean

enum

required

Creates a contact-only ShipperUser with no login: it can be used as an order contact and in the address book but cannot sign into Hub. No login account is provisioned, no shop or role is linked, and no email is sent (the email address is stored as contact data only).

Allowed:

Responses

401

unauthorized

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 shipperuser