v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Team Member Profiles (Member Groups)

Update members in a team member profile (member group)

Add or remove team members from a profile. Required scope: team-members:write Organization authorization: supported

post/api/v1/team-member-profiles/{id}/members

Path parameters

idinteger required

Request body

action'add' | 'remove' required

Action to perform on team members in the profile * add - Add team members to the profile * remove - Remove team members from the profile

team_member_idsinteger[] nullable

Example request

{
  "action": "add"
}

Response

Updated team member profile (Member group)

idinteger required

Id of the team member profile

teamIdinteger

Team id of team member profile

namestring required

The team member profile name

descriptionstring nullable

The team member profile description

role'admin' | 'user' | 'other' required

priceGroupIdinteger nullable

The price group for this team member profile

costGroupIdinteger nullable

The cost group for this team member profile

canPayWithTeamWalletboolean

Indicates if the team member profile gives access to pay with the team wallet in the Monta shop (e.g. charge keys, stickers). Team wallet payment for charging sessions is controlled by teamWalletChargePaymentType

canManageTeamWalletboolean

Indicates if team member profile has access to withdraw and deposit from your team wallet to your bank account

canDepositToWalletboolean nullable

Indicates if team member profile can deposit to team wallet

canWithdrawFromWalletboolean nullable

Indicates if team member profile can withdraw from team wallet

canManageChargeKeysboolean nullable

Indicates if team member profile can manage charge keys for the team

canRequestSponsoringboolean

Indicates if the team member profile is allowed to request sponsoring from this team for their charge point

canManageTeamMembersboolean

Indicates that the team member profile can view and manage other members settings

canConfigureChargePointsboolean

Indicates that the team member profile can configure charge points

On which chargers is the team member allowed to pay with Team Wallet? * all - On any charger (including roaming chargers) * partner - On chargers with the same partner as this team * operator - On chargers with the same operator as this team * team - On chargers belonging to this team * selected_operators - On chargers from selected operators * none - The team member is not allowed to pay with Team Wallet for any charge session

canPayForChargesCountryIdsinteger[] nullable

List of country ids for which the team member can pay for charges

createdAtstring date-time nullable

Date the team member profile was created

updatedAtstring date-time nullable

Date the team member profile was updated

deletedAtstring date-time nullable

Date the team member profile was deleted

kwhPriceCapAcnumber nullable

Maximum price per kWh in the team currency that the team will cover when charging on AC.

kwhPriceCapDcnumber nullable

Maximum price per kWh in the team currency that the team will cover when charging on DC.

sponsoredPriceGroupIdinteger nullable

Price group used to reimburse members in this profile for home charging. null means the employee's own cost price group is cloned at SCP creation time.

autoApproveElectricityCostboolean

When true, employee-submitted electricity costs are auto-approved for SCPs created for members in this profile.

reimbursementEnabledboolean

Master switch — whether members in this profile participate in home reimbursement.

reimbursementPayoutSchedule'end-of-month' | 'realtime' | 'other'

reimbursementSubscriptionboolean

Whether the operator reimburses the charge-point subscription price for members in this profile.

Example response

{
  "id": 1,
  "teamId": 42,
  "name": "Example profile 1",
  "description": "description",
  "priceGroupId": 1,
  "costGroupId": 1,
  "teamWalletChargePaymentType": "none",
  "canPayForChargesCountryIds": [
    1,
    2,
    3
  ],
  "operator": {
    "id": 14,
    "name": "Monta",
    "identifier": "monta",
    "partnerId": 1,
    "vatNumber": "FOO-123-ABC"
  },
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T16:56:45.99Z",
  "deletedAt": "2022-05-12T16:56:45.99Z",
  "kwhPriceCapAc": 2.5,
  "kwhPriceCapDc": 5,
  "sponsoredPriceGroupId": 1
}