Delete Appointment
highlevel.delete_event
ActionCRM & salesconnection required
Calls the HighLevel API with the connection's credentials.
Delete an appointment or blocked slot from a calendar.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- HighLevel
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"} for a marketplace app, or {"access_token": "…"} for a Private Integration Token
- Config it needs
- location_id, user_type, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
event_id The appointment (event) id. For one occurrence of a recurring appointment pass the instance id; for the whole series pass the masterEventId. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
succeeded True when HighLevel confirmed the delete. | boolean | — |
reported False when HighLevel answered 2xx without a success flag — accepted, but not confirmed. | boolean | — |
response HighLevel's delete response exactly as sent. | object | — |
event_id The event that was deleted. | string | — |
{
"event_id": "",
"reported": false,
"response": {},
"succeeded": false
}Notes
- To cancel an appointment but keep it on the calendar, use highlevel.update_appointment with appointment_status 'cancelled'.
See Delete Appointment run in a workflow.
In a technical demo we add the HighLevel connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.