v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Nested teams

Nested team invite

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

post/api/v1/nested-teams/invite

Request body

parentTeamIdinteger required

Id of the parent team, the one who sends the invite

nestedTeamIdinteger required

Id of the nested team, the one who receives the invite

priceGroupIdinteger required

Price group applied to the nested team

access'all' | 'selected' required

selectedChargePointIdsinteger[] nullable

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

selectedSiteIdsinteger[] nullable

List of site ids nested team access will be assigned to

Example request

{
  "parentTeamId": 1,
  "nestedTeamId": 2,
  "priceGroupId": 3
}

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

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"
}