Create (invite) a team member

Create (invite) a user to join a team, invitation can be done via userId, email and/or phone. A user that does not exist in yet will have a null userId.

Required scope: team-members:write
Organization authorization: supported

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int64
> 0

Id of the team that the user will be invited

int64 | null
> 0

Id of the user to be invited
Note: When inviting by userId the fields email or phone must not be provided.

string | null

Email of the user to be invited
Note: When inviting by email the fields userId or phone must not be provided.

string | null
^\+[1-9]\d{1,14}$

Phone of the user to be invited
Note: When inviting by phone the fields userId or email must not be provided.

string
enum
required

Role for this member within the team

Allowed:
int64 | null

The price group for this team member, when not provided the default team price group will be applied

int64 | null

The cost group for this team member

int64 | null

The team member profile id to apply to this team member

boolean
Defaults to false

Indicates if the team member can configure charge points

boolean
Defaults to false

Gives the team member 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

boolean
Defaults to false

Allows the team member to request sponsoring from this team for their charge point

boolean
Defaults to false

Allows the team member to view and manage other members settings

string | null
enum
Defaults to none

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

Allowed:
boolean
Defaults to false
deprecated

Deprecated: use canDepositToWallet and canWithdrawFromWallet instead. When set to true, automatically grants both deposit and withdraw permissions.

boolean | null

Gives the team member permission to deposit to the team wallet

boolean | null

Gives the team member permission to withdraw from the team wallet

boolean | null

Gives the team member permission to manage charge keys for the team

canPayForChargesCountryIds
array of int32s | null

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

canPayForChargesCountryIds
string | null

A note for the team member

chargePointIds
array of int64s | null

Ids of the charge point this team member with will have access

chargePointIds
string | null

External Id of this entity, managed by you.

partnerCustomPayload
object | null

Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.

boolean
Defaults to true

Controls whether an invitation email and/or SMS is sent to the user based on the provided email and phone fields.

boolean
Defaults to false
deprecated

Deprecated: use immediateAccess instead. When true, the invitation is granted immediately: existing users are added to the team in accepted state, and for new users the immediate-access intent is persisted on the invitation so it is honoured when they later register.

boolean | null
Defaults to false

Grants the invited member access to the team immediately, without waiting for them to accept the invitation. When true and the user already exists, the team member is created in accepted state so the operator can configure pricing, charge-point access and other settings right away. When true and the user does not yet exist, the immediate-access intent is persisted on the invitation and applied when the user registers — the team member is then created in accepted state with the inviter recorded as the acceptor (operator-initiated acceptance). If both immediateAccess and the deprecated autoAccept are sent, immediateAccess takes precedence.

number | null
> 0

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

number | null
> 0

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

int64 | null
> 0

Price group used to reimburse this team member for home charging. Omit or set null to use the employee's own cost price group (cloned at SCP creation time).

boolean
Defaults to false

When true, employee-submitted electricity costs are auto-approved for SCPs created for this team member.

boolean
Defaults to false

Master switch — whether the team member participates in home reimbursement.

string | null
enum

Default payout schedule applied to sponsored charge points created for this team member.

Allowed:
boolean
Defaults to false

Whether the operator reimburses the charge-point subscription price.

Responses

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