Onboarding Profiles

Retrieve a list of onboarding profiles

GET

https://partner-api.monta.com

/api/v1/onboarding-profiles

Required scope: teams:read
Organization authorization: supported

Retrieve a list of onboarding profiles › query Parameters

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

number of items per page (between 1 and 100, default 10)

Default: 10

Retrieve a list of onboarding profiles › Responses

List of onboarding profiles

OffsetBasedResponse_34

OnboardingProfile[] · required

MontaPage.Meta · required

GET/api/v1/onboarding-profiles

curl https://partner-api.monta.com/api/v1/onboarding-profiles \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 1,
      "operatorId": 1,
      "name": "Fleet drivers",
      "description": "Company car drivers",
      "enabled": true,
      "inUseCount": 3,
      "steps": [
        {
          "step": "SETUP_CHARGING_RULE",
          "config": "scheduled",
          "displayMode": "full_screen"
        }
      ],
      "welcomeText": {
        "type": "home",
        "enabled": true,
        "slots": {
          "key": {
            "mode": "custom",
            "text": "Your charger is ready",
            "follows": "ready"
          }
        }
      },
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T16:56:45.99Z"
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

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

Create an onboarding profile › Request Body

CreateOnboardingProfile

name

string · minLength: 1 · required

Name of the profile, unique per operator.

Example: Fleet drivers

OnboardingStep[] · minItems: 1 · required

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

description

string | null

Description of the profile.

Example: Company car drivers

enabled

boolean | null

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

Example: true

object

Optional welcome screen text overrides.

Create an onboarding profile › Responses

Onboarding profile created

OnboardingProfile

name

string · required

Name of the profile, unique per operator

Example: Fleet drivers

OnboardingStep[] · required

The onboarding steps a linked team receives, as {step, config?, displayMode?} entries.

id

integer · int64

Id of this onboarding profile

Example: 1

operatorId

integer · int64

Id of the operator this profile belongs to

Example: 1

description

string | null

Description of the profile

Example: Company car drivers

enabled

boolean

Whether the profile can be assigned to teams

Example: true

inUseCount

integer · int64

Number of teams currently linked to this profile

Example: 3

object

Welcome screen text overrides applied to linked teams; null when not configured.

createdAt

string | null · date-time

Creation date of this profile

Example: 2022-05-12T15:56:45.99Z

updatedAt

string | null · date-time

Date this profile was last updated

Example: 2022-05-12T16:56:45.99Z

POST/api/v1/onboarding-profiles

curl https://partner-api.monta.com/api/v1/onboarding-profiles \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Fleet drivers",
  "description": "Company car drivers",
  "enabled": true,
  "steps": [
    {
      "step": "SETUP_CHARGING_RULE",
      "config": "scheduled",
      "displayMode": "full_screen"
    }
  ],
  "welcomeText": {
    "type": "home",
    "enabled": true,
    "slots": {
      "key": {
        "mode": "custom",
        "text": "Your charger is ready",
        "follows": "ready"
      }
    }
  }
}'

Example Request Body

{
  "name": "Fleet drivers",
  "description": "Company car drivers",
  "enabled": true,
  "steps": [
    {
      "step": "SETUP_CHARGING_RULE",
      "config": "scheduled",
      "displayMode": "full_screen"
    }
  ],
  "welcomeText": {
    "type": "home",
    "enabled": true,
    "slots": {
      "key": {
        "mode": "custom",
        "text": "Your charger is ready",
        "follows": "ready"
      }
    }
  }
}

json

Example Responses

{
  "id": 1,
  "operatorId": 1,
  "name": "Fleet drivers",
  "description": "Company car drivers",
  "enabled": true,
  "inUseCount": 3,
  "steps": [
    {
      "step": "SETUP_CHARGING_RULE",
      "config": "scheduled",
      "displayMode": "full_screen"
    }
  ],
  "welcomeText": {
    "type": "home",
    "enabled": true,
    "slots": {
      "key": {
        "mode": "custom",
        "text": "Your charger is ready",
        "follows": "ready"
      }
    }
  },
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T16:56:45.99Z"
}

json

application/json

Retrieve a single onboarding profile

GET

https://partner-api.monta.com

/api/v1/onboarding-profiles/{profileId}

Required scope: teams:read
Organization authorization: supported

Retrieve a single onboarding profile › path Parameters

profileId

integer · int64 · required

Retrieve a single onboarding profile › Responses

Onboarding profile with provided id

OnboardingProfile

name

string · required

Name of the profile, unique per operator

Example: Fleet drivers

OnboardingStep[] · required

The onboarding steps a linked team receives, as {step, config?, displayMode?} entries.

id

integer · int64

Id of this onboarding profile

Example: 1

operatorId

integer · int64

Id of the operator this profile belongs to

Example: 1

description

string | null

Description of the profile

Example: Company car drivers

enabled

boolean

Whether the profile can be assigned to teams

Example: true

inUseCount

integer · int64

Number of teams currently linked to this profile

Example: 3

object

Welcome screen text overrides applied to linked teams; null when not configured.

createdAt

string | null · date-time

Creation date of this profile

Example: 2022-05-12T15:56:45.99Z

updatedAt

string | null · date-time

Date this profile was last updated

Example: 2022-05-12T16:56:45.99Z

GET/api/v1/onboarding-profiles/{profileId}

curl https://partner-api.monta.com/api/v1/onboarding-profiles/:profileId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": 1,
  "operatorId": 1,
  "name": "Fleet drivers",
  "description": "Company car drivers",
  "enabled": true,
  "inUseCount": 3,
  "steps": [
    {
      "step": "SETUP_CHARGING_RULE",
      "config": "scheduled",
      "displayMode": "full_screen"
    }
  ],
  "welcomeText": {
    "type": "home",
    "enabled": true,
    "slots": {
      "key": {
        "mode": "custom",
        "text": "Your charger is ready",
        "follows": "ready"
      }
    }
  },
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T16:56:45.99Z"
}

json

application/json

Update an onboarding profile

PATCH

https://partner-api.monta.com

/api/v1/onboarding-profiles/{profileId}

Changing steps or welcomeText re-applies the profile to every linked team.

Required scope: teams:write
Organization authorization: supported

Update an onboarding profile › path Parameters

profileId

integer · int64 · required

Update an onboarding profile › Request Body

PatchOnboardingProfile

name

string | null

Name of the profile, unique per operator.

Example: Fleet drivers

description

string | null

Description of the profile.
Note: Send null to clear it; omit the field to leave it unchanged.

Example: Company car drivers

enabled

boolean | null

Whether the profile can be assigned to teams.

Example: true

array | null

Replaces the full step set and re-applies it to every linked team. Omit to leave steps unchanged.

object

Replaces the welcome screen text overrides and re-applies them to linked teams. Omit to leave unchanged.

Update an onboarding profile › Responses

Updated onboarding profile

OnboardingProfile

name

string · required

Name of the profile, unique per operator

Example: Fleet drivers

OnboardingStep[] · required

The onboarding steps a linked team receives, as {step, config?, displayMode?} entries.

id

integer · int64

Id of this onboarding profile

Example: 1

operatorId

integer · int64

Id of the operator this profile belongs to

Example: 1

description

string | null

Description of the profile

Example: Company car drivers

enabled

boolean

Whether the profile can be assigned to teams

Example: true

inUseCount

integer · int64

Number of teams currently linked to this profile

Example: 3

object

Welcome screen text overrides applied to linked teams; null when not configured.

createdAt

string | null · date-time

Creation date of this profile

Example: 2022-05-12T15:56:45.99Z

updatedAt

string | null · date-time

Date this profile was last updated

Example: 2022-05-12T16:56:45.99Z

PATCH/api/v1/onboarding-profiles/{profileId}

curl https://partner-api.monta.com/api/v1/onboarding-profiles/:profileId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Fleet drivers",
  "description": "Company car drivers",
  "enabled": true,
  "steps": [
    {
      "step": "SETUP_CHARGING_RULE",
      "config": "scheduled",
      "displayMode": "full_screen"
    }
  ],
  "welcomeText": {
    "type": "home",
    "enabled": true,
    "slots": {
      "key": {
        "mode": "custom",
        "text": "Your charger is ready",
        "follows": "ready"
      }
    }
  }
}'

Example Request Body

{
  "name": "Fleet drivers",
  "description": "Company car drivers",
  "enabled": true,
  "steps": [
    {
      "step": "SETUP_CHARGING_RULE",
      "config": "scheduled",
      "displayMode": "full_screen"
    }
  ],
  "welcomeText": {
    "type": "home",
    "enabled": true,
    "slots": {
      "key": {
        "mode": "custom",
        "text": "Your charger is ready",
        "follows": "ready"
      }
    }
  }
}

json

Example Responses

{
  "id": 1,
  "operatorId": 1,
  "name": "Fleet drivers",
  "description": "Company car drivers",
  "enabled": true,
  "inUseCount": 3,
  "steps": [
    {
      "step": "SETUP_CHARGING_RULE",
      "config": "scheduled",
      "displayMode": "full_screen"
    }
  ],
  "welcomeText": {
    "type": "home",
    "enabled": true,
    "slots": {
      "key": {
        "mode": "custom",
        "text": "Your charger is ready",
        "follows": "ready"
      }
    }
  },
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T16:56:45.99Z"
}

json

application/json

Delete an onboarding profile

DELETE

https://partner-api.monta.com

/api/v1/onboarding-profiles/{profileId}

Linked teams are detached and keep their current onboarding steps, which become editable again.

Required scope: teams:delete
Organization authorization: supported

Delete an onboarding profile › path Parameters

profileId

integer · int64 · required

Delete an onboarding profile › Responses

Onboarding profile deleted

No data returned

Nested teams Operator Lists