Edit an appointment type (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 request fields appointment_type.display_name, appointment_type.ehr_appt_descriptor_ids; removes request field appointment_type.emr_appt_descriptor_ids; adds response 422; adds response fields data.active, data.data_source_id, data.display_name, data.foreign_id (+2 more).

This endpoint updates an existing appointment type's attributes such as name, minutes, and bookable_online. On an appointment type synced from the EHR only display_name and bookable_online can change; any other field returns 422.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
Query Params
string
required

Used to scope the request to the specified institution

Body Params

Edit an appointment type

int32

Id of the associated location, required when appointment types are location specific

appointment_type
object
required
Headers
string
required
Defaults to v3.1.0

The NexHealth API version

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
ChangelogMCP serverErrorsdevelopers@nexhealth.com