users

Replace a user's entire weekly planning

Changed on

Replaces a user's entire weekly availability planning with a new one. The request body must contain an array of time ranges for each day of the week (Monday through Sunday). Planning must be enabled in the user's settings (check is_planning via GET /users/{userId}/plannings first). If planning is disabled, the request returns 406.

Permission: Users Write required.

Monitoring: Required. Modifying another user's planning is a supervisory operation. Returns 401 Unauthorized if Monitoring is OFF on your API key.

put/users/{userId}/plannings

Request

  • Base URL
    https://public-api.ringover.com/v2
  • URL
    https://public-api.ringover.com/v2/users/{userId}/plannings
  • Auth
    API key in header Authorization

Path parameters

userIdinteger required

The identifier of the user

Request body

dayinteger

Day of the week (0 => Monday, 6 => Sunday)

startinteger

Start time in minutes (0 => 0:00)

endinteger

End time in minutes (1440 => 24:00)

Example request

[
  {
    "end": 1440
  }
]

Response

Successful operation

Changes