Working Hours
Create working hour
This endpoint creates an availability for a provider at the specified location. Exactly one of days, specific_date, or custom_recurrence must be configured.
post/working_hours
Query parameters
subdomainstring required
Used to scope the request to the specified institution
location_idinteger required
Used to scope the request to the specified location
Headers
Nex-Api-Versionstring required
The NexHealth API version
Request body
Example request
{
"working_hour": {
"provider_id": 7,
"begin_time": "09:00",
"end_time": "16:00",
"operatory_id": 149,
"appointment_type_ids": [
27
],
"days": [
"Monday",
"Wednesday"
],
"specific_date": "2024-11-03",
"custom_recurrence": {
"num": 3,
"ref": "2024-11-03",
"unit": "week"
},
"active": true
}
}Response
Successful
Example response
{
"description": "Description",
"error": [
"Error message"
],
"data": {
"id": 12,
"provider_id": 7,
"location_id": 3,
"operatory_id": 149,
"begin_time": "10:30",
"end_time": "17:00",
"days": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday"
],
"specific_date": "2022-11-03",
"custom_recurrence": {
"num": 3,
"unit": "day",
"ref": "2022-11-03"
},
"tz_offset": "-0700",
"active": true,
"source": "synced",
"label": {
"id": 113,
"location_id": 115,
"name": "New patient appointments"
}
},
"count": 2
}