Skip to main content
POST
Create User

Authorizations

Authorization
string
header
required

Consumer JWT minted by the tenant's backend

X-Rollout-Credential-Id
string
header
required

The Rollout Credential ID to use for queries/mutations

Query Parameters

fields
string

Comma-separated top-level fields to return; the parameter can also be repeated, once per field. id is always returned. Omit it, or pass allFields, to get every field, including original. Unknown names return 400.

Body

email
string
required
firstName
string
required
lastName
string
required
phone
string
required
role
string
required
status
string
required
username
string
required
type
string
required
address
object
required
timezone
string | null
participatingOfficeIds
string[]
password
string

Response

The created users: one, or for an app that keeps a separate user per office, one for each of participatingOfficeIds.

id
string
required
firstName
string

Present unless the request's fields leaves it out.

lastName
string

Present unless the request's fields leaves it out.

email
string

Present unless the request's fields leaves it out.

phone
string

Present unless the request's fields leaves it out.

role
string

Present unless the request's fields leaves it out.

status
string

Present unless the request's fields leaves it out.

timezone
string | null

Present unless the request's fields leaves it out.

created
string | null

Present unless the request's fields leaves it out.

updated
string | null

Present unless the request's fields leaves it out.

rolloutUpdated
string

Present unless the request's fields leaves it out.

originalIds
object

Present unless the request's fields leaves it out.

original
object

Present unless the request's fields leaves it out.

address
object | null

Present unless the request's fields leaves it out.

username
string

Present unless the request's fields leaves it out.

type
string

Present unless the request's fields leaves it out.

offices
object[]

Present unless the request's fields leaves it out.