Skip to main content
POST
Create Office

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

name
string
required
phone
string
required
email
string
required
company
string
required
address
object
timezone
string | null
requiresTemplate
boolean | null

Response

The created office.

The created office.

id
string
required
name
string

Present unless the request's fields leaves it out.

address
object | null

Present unless the request's fields leaves it out.

phone
string

Present unless the request's fields leaves it out.

email
string

Present unless the request's fields leaves it out.

timezone
string | null

Present unless the request's fields leaves it out.

company
string

Present unless the request's fields leaves it out.

requiresTemplate
boolean | 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.