Create a team

post

https://partner-api.monta.com/api/v1/teams

Required scope: teams:write
Organization authorization: supported

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

userId

int64 | null

Id of the user that owns the team.

userEmail

string | null

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

operatorId

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.

name

string

required

length ≥ 1

Name of the team.

contactEmail

string

required

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

financeEmail

string | null

Finance contact email of the team.

financeCommunicationEmail

string | null

Recipient for important payment notices (late payment, freeze warning, frozen). When not set, these go to financeEmail.

legalEmail

string | null

Legal contact email of the team.

type

string

enum

required

type of the team.

Allowed:

address

object

required

Address of the team. Only countryId is mandatory. Address1, city, and zipCode must be provided together or all left null.

companyName

string | null

The company name for the team.

vatNumber

string | null

The vat number for the team.

companyRegistrationNumber

string | null

The company registration number for the team.

partnerExternalId

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.

paymentMethod

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:

themeId

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?, displayMode?} entries. Present in the list means enabled; the list is the full enabled set.

onboardingSteps

onboardingProfileId

int64 | null

> 0

Onboarding profile to apply, from GET /onboarding-profiles. Copies the profile's steps onto the team and locks them to the profile. Cannot be combined with onboardingSteps.

onboardingWelcomeText

object | null

The app-onboarding welcome-screen text override. Omit to use Monta's default copy.

201Team created

400The request is invalid

401Consumer with provided credentials was not found

403Operator doesn't have access to resource

404Entity with the provided id was not found