Endpoints

Delete appointment type (beta)

delete
https://nexhealth.info/appointment_types/
šŸš§

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 422; adds response fields data.active, data.data_source_id, data.display_name, data.foreign_id (+2 more).

This endpoint permanently deletes an appointment type by its NexHealth ID. Appointment types synced from the EHR cannot be deleted and return 422.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requestsā€¦
LoadingLoadingā€¦
Path Params
int32
required

NexHealth ID of the appointment type

Query Params
string
required

Used to scope the request to the specified institution

int32

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

Headers
string
required
Defaults to v3.1.0

The NexHealth API version

Responses

Updated 20 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoadingā€¦
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 20 days ago

Did this page help you?
ChangelogMCP serverErrorsdevelopers@nexhealth.com