Skip to main content
POST
/
api
/
schedule
/
schedules.create
Create schedules
curl --request POST \
  --url https://api.example.com/api/schedule/schedules.create \
  --header 'Content-Type: application/json' \
  --data '
{
  "team": "872815618512410358",
  "rrule": "RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR;DTSTART=20241104T120000;UNTIL=20241105T120000",
  "resource": "872815618512410358",
  "hour_ranges": [
    {
      "hour_range": "12:34:56/PT2H",
      "auto_correct": {
        "before_start": "PT1H30M20S",
        "after_start": "PT1H30M20S",
        "before_end": "PT1H30M20S",
        "after_end": "PT1H30M20S"
      },
      "paid_break": {
        "max_duration": "PT1H30M20S",
        "hour_range": "12:34:56/PT2H"
      }
    }
  ],
  "options": {
    "employee_resident_ratio": true,
    "text_color": "<string>",
    "special_hours": "12:34:56/PT2H",
    "schedule_on_bank_holidays": true
  },
  "schedule_template": "872815618512410358",
  "adjustment": {
    "value": "PT1H30M20S",
    "time": "12:34:56"
  },
  "break_time": {
    "min_duration": "PT1H30M20S",
    "hour_range": "12:34:56/PT2H"
  },
  "remark": "<string>",
  "bypass_overlapping_dates": false
}
'

Body

application/json
team
string<snowflake>
required
Example:

"872815618512410358"

rrule
string
required
Example:

"RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR;DTSTART=20241104T120000;UNTIL=20241105T120000"

resource
string<snowflake>
required
Example:

"872815618512410358"

hour_ranges
object[]
required
options
object
required
schedule_template
string<snowflake>
Example:

"872815618512410358"

adjustment
object
break_time
object
remark
string | null
Maximum string length: 65535
bypass_overlapping_dates
boolean
default:false

Response

default - undefined