NEnexhealth
Working Hours

Edit working hour (beta)

🚧 Beta

Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Adds response fields data.appointment_types[].active, data.appointment_types[].data_source_id, data.appointment_types[].display_name, data.appointment_types[].foreign_id (+13 more).

This endpoint updates an existing working hour. At most one of days, specific_date, or custom_recurrence can be provided. The appointment_types field is included in the response only when appointment_type_ids or appointment_category_ids were part of the update. Passing an empty appointment_type_ids array removes all appointment types from the working hour; omitting the key leaves them unchanged.

patch/working_hours/{id}

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/working_hours/{id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

ID of the working hour

Query parameters

subdomainstring required

Used to scope the request to the specified institution

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

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

countinteger

Number of total objects, in case of collection.

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",
      "color_hex": "#1E90FF",
      "default_duration_minutes": 40,
      "active": true
    },
    "schedule_template": {
      "id": 7,
      "name": "Hygiene week",
      "color_hex": "#4caf50",
      "active": true,
      "location_id": 115,
      "foreign_id": "42"
    },
    "type": "booking",
    "inherit_label_restrictions": true,
    "appointment_types": [
      {
        "id": 1,
        "name": "Medical",
        "parent_type": "Institution",
        "parent_id": 1,
        "minutes": 15,
        "display_name": "Hygiene visit",
        "source": "manual",
        "active": true,
        "foreign_id": "42",
        "data_source_id": 7
      }
    ]
  },
  "count": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.