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