HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Partner invite access policy / update

Update a partner invite access policy. Only provided fields are updated; nested partnerAccess and
restrictions objects are replaced entirely when provided.

The default access policy ("Full private access") cannot be updated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params

Partner invite access policy update. All fields are optional — only provided fields are updated.
The operatorId field is immutable after creation and must not be provided.

Nested object replacement: when partnerAccess or restrictions is provided, the entire
object is replaced — not deep-merged. Previously stored IDs are removed as part of the
replacement when the new type does not use them.

The default access policy ("Full private access") cannot be updated and returns 422.

string
length ≤ 255
partnerAccess
object

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.

boolean
Responses

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