DELETE
/api/public/v1/calendar-events/{eventId}

Delete a calendar event

Removes an event, or one occurrence of a recurring one. Guests are mailed exactly what was removed, so their calendar app drops that and keeps the rest: deleting one occurrence cancels just that occurrence, deleting this-and-following re-sends the series ending before it, and a full delete cancels the event — every occurrence of a series. Each cancellation carries a Remove from calendar link. Employees aren’t mailed. Only the event’s creator may delete it — `calendar:admin` covers anybody else’s.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.

calendar:write

Path Parameters

NameTypeRequiredDescription
eventIdstringRequiredEvent ID.

Query Parameters

NameTypeRequiredDescription
deleteScopestring
single
future
all
Optional`all` removes the record. `single` excludes one date from the series. `future` ends the series the day before `recurrenceDate`.Default: all
recurrenceDatestringOptionalISO 8601. Required by the `single` and `future` scopes.
DELETEExample request
curl
curl -X DELETE "https://www.pxb.app/api/public/v1/calendar-events/{eventId}" \
  -H "Authorization: Bearer your_access_token"
200Example response
json
{
  "message": "Calendar event deleted!",
  "content": {
    "eventId": "cal_5150"
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Calendar
/calendar
  1. Open an event you created.
  2. Delete.