Sign in

v1

latestOpenAPI 3.0.32026-08-0613775357.6 KB
availabilities

Create availability

Creates a new availability time block for a user.

Note: In the current version of the API, updating part-time availabilities will NOT automatically update existing assignments and their suggested time entries to match.

post/users/{user_id}/availabilities

Path parameters

user_idinteger required

The ID of the user.

Request body

starts_atstring date nullable

The effective start date for the availability block. Null implies the past.

ends_atstring date nullable

The effective end date for the availability block. Null implies the future.

day0number required

Available hours on Sunday.

day1number required

Available hours on Monday.

day2number required

Available hours on Tuesday.

day3number required

Available hours on Wednesday.

day4number required

Available hours on Thursday.

day5number required

Available hours on Friday.

day6number required

Available hours on Saturday.

Example request

{
  "starts_at": "2026-01-30",
  "ends_at": "2026-07-28",
  "day1": 8,
  "day2": 8,
  "day3": 4,
  "day4": 8,
  "day5": 8
}

Response

The availability block was created successfully.

idinteger required

The unique identifier for the availability block.

user_idinteger required

The ID of the user this availability block belongs to.

day0number required

Available hours on Sunday.

day1number required

Available hours on Monday.

day2number required

Available hours on Tuesday.

day3number required

Available hours on Wednesday.

day4number required

Available hours on Thursday.

day5number required

Available hours on Friday.

day6number required

Available hours on Saturday.

starts_atstring date nullable required

The effective start date for the availability block. Null implies the past.

ends_atstring date nullable required

The effective end date for the availability block. Null implies the future.

created_atstring date-time

The time of creation.

updated_atstring date-time

The time of the last update.

Example response

{
  "id": 52,
  "user_id": 269,
  "day1": 8,
  "day2": 8,
  "day3": 4,
  "day4": 8,
  "day5": 8,
  "starts_at": "2017-01-30",
  "ends_at": "2017-07-28",
  "created_at": "2024-08-27T12:00:00Z",
  "updated_at": "2024-08-27T12:00:00Z"
}