Patch an existing team

Required scope: teams:write
Organization authorization: supported

Note: To update the operator team status, use the dedicated PATCH /teams/{id}/operator-team endpoint instead.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
Body Params
int64 | null

Id of the user that owns the team

string | null

email of the user that owns the team, useful when the userId is not known

string | null

Name of the team

string | null

Contact email of the team. Named "email" in the GET APIs.

string | null

Finance contact email of the team

string | null

Legal contact email of the team.

address
object | null

Address information

string | null

The company name for the team

string | null

The vat number for the team

string | null

The company registration number for the team

string | null

External Id of this entity, managed by you.

partnerCustomPayload
object | null

Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.

string | null
enum

The payment method for the team

Allowed:
int32 | null

The theme id to assign to the team.
Note: When theme is provided, it must belong to the same operator as the team

onboardingSteps
array of objects | null

The onboarding steps enabled for the team, as {step, config?} entries. Sending the list replaces the full enabled set; omitting it leaves the steps unchanged.

onboardingSteps
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json