API Reference
Monta.com

Create an onboarding profile

post
https://partner-api.monta.com/api/v1/onboarding-profiles

Creates a reusable onboarding template for your operator. Assign it to a team with onboardingProfileId on POST /teams or PATCH /teams/{teamId}.

Required scope: teams:write
Organization authorization: supported

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

Name of the profile, unique per operator.

string | null

Description of the profile.

boolean | null

Whether the profile can be assigned to teams. Defaults to true.

steps
array of objects
required
length ≥ 1

The onboarding steps a linked team receives, as {step, config?, displayMode?} entries. Present in the list means enabled.

steps*
string
enum
required
length ≥ 1

The onboarding step key. Present in the list means the step is enabled for the team.

Allowed:
string | null
enum

Optional per-step configuration, interpreted by the step. SETUP_CHARGING_RULE: the charging rule type, one of scheduled, smart. ADD_TEAM_MEMBER: the member type the invite creates, one of member, admin; null/absent keeps the app's native invite flow, which picks the role. Null/absent for all other steps.

Allowed:
string | null
enum

How the app presents the step: full_screen (default) or waiting_step (a passive card). waiting_step is rejected for SETUP_CHARGING_RULE. Absent/null defaults to full_screen.

Allowed:
welcomeText
object | null

Optional welcome screen text overrides.

Responses

Updated 17 days ago

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

Updated 17 days ago

Did this page help you?