v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Schedules

Update a schedule.

Required scope: schedules:write </br>Organization authorization: supported

put/api/v1/schedules/{id}

Path parameters

idinteger required

Request body

namestring nullable

Name of the schedule.

price_group_idinteger nullable

Id of the default price group applied during scheduled windows.

visibility'private' | 'public'

definitions:

private - Indicates the charge point access is private, only available to users from operator umbrella.
public - Indicates the charge point access is public.

timezonestring nullable

Timezone for interpreting the schedule entry times.

selected_charge_point_idsinteger[] nullable

Replaces the set of charge points assigned to this schedule. Omit to leave unchanged.

selected_site_idsinteger[] nullable

Replaces the set of sites assigned to this schedule. Omit to leave unchanged.

Example request

{
  "name": "Weekday Hours",
  "price_group_id": 99,
  "timezone": "Europe/Copenhagen",
  "entries": [
    {
      "id": 12,
      "from": "08:00:00",
      "to": "18:00:00",
      "price_group_id": 42
    }
  ]
}

Response

The updated schedule

idinteger required

Id of the schedule

teamIdinteger required

Id of the team that owns this schedule

namestring required

Name of the schedule

visibility'private' | 'public' required

definitions:

private - Indicates the charge point access is private, only available to users from operator umbrella.
public - Indicates the charge point access is public.

timezonestring required

Timezone for interpreting the schedule entry times

priceGroupIdinteger nullable

Id of the default price group applied during scheduled windows

entryCountinteger required

Number of entries in this schedule

selectedChargePointIdsinteger[] nullable

Ids of charge points directly assigned to this schedule

selectedSiteIdsinteger[] nullable

Ids of sites assigned to this schedule

createdAtstring date-time required

When the schedule was created

updatedAtstring date-time nullable

When the schedule was last updated

Example response

{
  "id": 42,
  "teamId": 12,
  "name": "Weekday Hours",
  "timezone": "Europe/Copenhagen",
  "priceGroupId": 99,
  "entryCount": 5,
  "entries": [
    {
      "id": 12,
      "from": "08:00:00",
      "to": "18:00:00",
      "priceGroupId": 42
    }
  ],
  "createdAt": "2023-03-16T15:37:23Z",
  "updatedAt": "2023-03-16T15:37:23Z"
}