Create or Update Availability Rule BETA

Description #

Creates or updates an availability rule for the authenticated account.

URL format #

api.cronofy.com/v1/availability_rules

Example Request #

POST /v1/availability_rules HTTP/1.1
Host: api.cronofy.com
Authorization: Bearer {ACCESS_TOKEN}
Content-Type: application/json; charset=utf-8

{
  "availability_rule_id": "default",
  "tzid": "America/Chicago",
  "calendar_ids": [
    "cal_n23kjnwrw2_jsdfjksn234"
  ],
  "weekly_periods": [
    {
      "day": "monday",
      "start_time": "09:30",
      "end_time": "12:30"
    },
    {
      "day": "wednesday",
      "start_time": "09:30",
      "end_time": "12:30"
    }
  ]
}

Request parameters #

availability_rule_id required  #

The String that uniquely identifies the availability rule. The first request made for an availability_rule_id will create an available period for the account and subsequent requests will update its details.

Usually this will be your own internal ID for the available period, encoded as an ASCII-only String of up to 64 characters.

tzid required  #

A String representing a known time zone identifier from the IANA Time Zone Database.

Common examples are:

  • Etc/UTC
  • Europe/Paris
  • America/Chicago
calendar_ids optional  #

An Array specifying the calendars that should impact the user’s availability. When provided at least one calendar must be specified.

weekly_periods required  #

An Array of weekly recurring periods for the availability rule.

weekly_period.day required  #

A String the week day this period applies to.

Valid options are:

  • sunday
  • monday
  • tuesday
  • wednesday
  • thursday
  • friday
  • saturday
weekly_period.start_time required  #

A String the time of day the period should start expressed as a 24hr clock string, eg: 09:30.

weekly_period.end_time required  #

A String the time of day the period should end expressed as a 24hr clock string, eg: 16:30.

Example Response #

HTTP/1.1 200 Success
Content-Type: application/json; charset=utf-8

{
  "availability_rule_id": "default",
  "tzid": "America/Chicago",
  "calendar_ids": [
    "cal_n23kjnwrw2_jsdfjksn234"
  ],
  "weekly_periods": [
    {
      "day": "monday",
      "start_time": "09:30",
      "end_time": "12:30"
    },
    {
      "day": "wednesday",
      "start_time": "09:30",
      "end_time": "12:30"
    }
  ]
}
Search