Partner invite access policy / create

post

https://{tenantUrl}/public-api/resources/partner-invite-access-policies/v1.0

Create a new partner invite access policy

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Partner invite access policy

operatorId

integer

The operator ID. Required for global admin tokens. Defaults to the token's operator for operator-scoped tokens.

name

string

required

length ≤ 255

Name of the access policy.

partnerAccess

object

required

Controls which partners can use this policy when creating invites.

none — no partner restriction; any partner under the operator can use the policy, including future partners
allow — only the specified partners (partnerIds is required)

restrictions

object

Defines which of the partner's charge points invited users can access.
Each sub-restriction is optional on input — an omitted sub-restriction is treated as none.
At most one sub-restriction can use allow or deny; providing more than one active sub-restriction is a validation error.
An empty object, or all sub-restrictions set to none, grants access to all of the partner's charge points.
To grant access to no charge points, set locations.type to allow with an empty locationIds list.
Location tag restrictions use locationTagIds; charge point tag restrictions use chargePointTagIds.
In responses all four sub-restrictions are always present.

includeSharedChargePoints

boolean

Defaults to false

When true, invited users also have access to charge points of other partners that are shared with the inviting partner.

Responses

201Partner invite access policy created successfully

401Access token is missing or invalid

403You do not have permission to perform the action

422The payload you provided is invalid

429Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*