Partner API
Set available hours
PUT /api/v2/calendar/hours - Replaces available hours. Accepts a clock-style schedule array [{ start, end, days }] or a legacy per-weekday map { enabled, start, end }.
PUT
/api/v2/calendar/hoursReplaces available hours. Accepts a clock-style schedule array [{ start, end, days }] or a legacy per-weekday map { enabled, start, end }.
Required scope: appointments (or *).
JSON body
| Name | Required | Description |
|---|---|---|
available_hours | Yes | Schedule array: [{ start, end, days: ["mon",...] }] with HH:MM times, or legacy per-weekday map { enabled, start, end } |
curl -s -X PUT -H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"available_hours": [
{
"start": "09:00",
"end": "12:00",
"days": [
"mon",
"tue",
"wed",
"thu",
"fri"
]
},
{
"start": "14:00",
"end": "17:00",
"days": [
"mon",
"tue",
"wed",
"thu",
"fri"
]
}
]
}' \
"https://benefitpath.com/api/v2/calendar/hours"{
"success": true,
"timezone": "America/New_York",
"available_hours": {
"mon": { "enabled": true, "start": "09:00", "end": "17:00", "intervals": [{ "start": "09:00", "end": "12:00" }, { "start": "14:00", "end": "17:00" }] },
"tue": { "enabled": true, "start": "09:00", "end": "17:00", "intervals": [{ "start": "09:00", "end": "12:00" }, { "start": "14:00", "end": "17:00" }] },
"wed": { "enabled": true, "start": "09:00", "end": "17:00", "intervals": [{ "start": "09:00", "end": "12:00" }, { "start": "14:00", "end": "17:00" }] },
"thu": { "enabled": true, "start": "09:00", "end": "17:00", "intervals": [{ "start": "09:00", "end": "12:00" }, { "start": "14:00", "end": "17:00" }] },
"fri": { "enabled": true, "start": "09:00", "end": "17:00", "intervals": [{ "start": "09:00", "end": "12:00" }, { "start": "14:00", "end": "17:00" }] },
"sat": { "enabled": false, "start": "09:00", "end": "17:00", "intervals": [] },
"sun": { "enabled": false, "start": "09:00", "end": "17:00", "intervals": [] }
}
}See Errors for the standard error envelope and rate limits.