Create a team

Required scope: teams:write
Organization authorization: supported

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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.

int64 | null
> 0

Id of the operator this team should be assigned to
Note: if not provided the team will be assigned to the default operator for the given consumer, if the default operator cannot be assigned the request will be rejected.

string
required
length ≥ 1

Name of the team.

string
required

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.

string
enum
required

type of the team.

Allowed:
address
object
required

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.
Note: if not provided the team will be created with the default payment method source.

Allowed:
int64 | 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. Present in the list means enabled; the list is the full enabled set.

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