Skip to main content
PUT
Update Team

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

Path Parameters

id
string
required

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
name
string
address
string
phone
string
city
string
zip
string

Response

Response for status 200

id
string
required
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.

name
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.

address
string

Present unless the request's fields leaves it out.

city
string

Present unless the request's fields leaves it out.

zip
string

Present unless the request's fields leaves it out.

userIds
string[]

The team's members, leaders included, as user ids. Members whose user hasn't synced are left out. Present unless the request's fields leaves it out.

leaderIds
string[]

The members who lead the team, as user ids. 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.