MOmonta
Onboarding Profiles

Create an onboarding profile

Changed on

Creates a reusable onboarding template for your operator. Assign it to a team with onboardingProfileId on POST /teams or PATCH /teams/{teamId}.</br></br>Required scope: teams:write </br>Organization authorization: supported

post/api/v1/onboarding-profiles

Request

  • Base URL
    https://partner-api.monta.com
  • URL
    https://partner-api.monta.com/api/v1/onboarding-profiles
  • Auth
    HTTP bearer

Request body

namestring required

Name of the profile, unique per operator.

descriptionstring nullable

Description of the profile.

enabledboolean nullable

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

Example request

{
  "name": "Fleet drivers",
  "description": "Company car drivers",
  "enabled": true,
  "steps": [
    {
      "step": "SETUP_CHARGING_RULE",
      "config": "scheduled",
      "displayMode": "full_screen"
    }
  ],
  "welcomeText": {
    "type": "home",
    "enabled": true
  }
}

Response

Onboarding profile created

idinteger

Id of this onboarding profile

operatorIdinteger

Id of the operator this profile belongs to

namestring required

Name of the profile, unique per operator

descriptionstring nullable

Description of the profile

enabledboolean

Whether the profile can be assigned to teams

inUseCountinteger

Number of teams currently linked to this profile

createdAtstring date-time nullable

Creation date of this profile

updatedAtstring date-time nullable

Date this profile was last updated

Example response

{
  "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
  },
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T16:56:45.99Z"
}

Changes