Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Nested teams

Update a nested team relation

Required scope: team-members:write </br>Organization authorization: supported

patch/api/v1/nested-teams/{relationId}

Path parameters

relationIdinteger required

Request body

priceGroupIdinteger nullable

Price group applied to the nested team

notestring nullable

A note (instructions, warning, information) you have entered for this nested team member

selectedChargePointIdsinteger[] nullable

List of charge point ids nested team access will be assigned to

Example request

{
  "priceGroupId": 1,
  "note": "A note for nested team member"
}

Response

Nested team invite sent

idinteger

Id of the nested team relation

userRole'user' required

The role assigned to the nested team

access'all' | 'selected' required
state'requested' | 'invited' | 'accepted' | 'rejected_at' | 'blocked' | 'expired' required
selectedChargePointIdsinteger[] nullable

Selected charge points nested team has access to

notestring nullable

Internal note for this nested team

createdAtstring date-time required

Datetime of the creation of nested team invite

updatedAtstring date-time nullable

Datetime of the update of nested team invite

invitedAtstring date-time nullable

Datetime nested team was invited

Example response

{
  "id": 1,
  "parentTeam": {
    "id": 1,
    "publicName": "Example Team",
    "memberCount": 10
  },
  "nestedTeam": {
    "id": 1,
    "publicName": "Example Team",
    "memberCount": 10
  },
  "priceGroup": {
    "id": 1,
    "name": "Standard Pricing"
  },
  "invitedByUser": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "displayName": "johndoe123"
  },
  "userRole": "user",
  "selectedChargePointIds": [
    41,
    72,
    93
  ],
  "note": "Internal note placeholder",
  "createdAt": "2022-07-27T18:11:41Z",
  "updatedAt": "2022-07-28T18:11:41Z",
  "invitedAt": "2022-07-28T18:11:41Z"
}