MOmonta
Onboarding Profiles

Update an onboarding profile

Changed on

Changing steps or welcomeText re-applies the profile to every linked team.</br></br>Required scope: teams:write </br>Organization authorization: supported

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

Request

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

Path parameters

profileIdinteger required

Request body

namestring nullable

Name of the profile, unique per operator.

descriptionstring nullable

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

enabledboolean nullable

Whether the profile can be assigned to teams.

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

Updated onboarding profile

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