Apaleo Official icon

Apaleo Official

Interact with Apaleo API

Actions5

Availability → Update Unit Group Availability

AI-generated

Summary

Patch the availability of a specified unit group over a given date range using a JSON Patch request body.

Inputs

  • Group (required) — API group to use; must be 'availability-v1'.
  • ID (required) — The ID of the unit group whose availability will be updated.
  • From (required) — The first date of the time period for availability modification (ISO date).
  • To (required) — The last date of the time period for availability modification (ISO date).
  • TimeSliceTemplate (required) — The time slice template to apply, either 'DayUse' or 'OverNight'.
  • Body (required) — A JSON Patch formatted array defining operations to apply to the unit group's availability; see http://jsonpatch.com/ for syntax.

Output shape

a single updated unit group availability record or an API response confirming the update.

Input parameters 'ID', 'From', 'To', 'TimeSliceTemplate', and 'Body' are required. The Body must be valid JSON parsed to form the PATCH request body. The API endpoint used is PATCH /availability/v1/unit-groups/{id} with query parameters from, to, and timeSliceTemplate set accordingly.

Links

Discussion