Loading ...

REST API: Delete Event | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Events » REST API: Delete Event
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 35

REST API: Delete Event

0 
 /5
0 (0votes)
Open API Guide
DELETE/api/events/{EventID}

Permanently remove an event from the intranet calendar by its ID. This deletes the event along with its attendee list, reminders, and associated RSVP data.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Required Parameters

ParameterTypeRequiredLocationDescription
EventIDIntegerYESPathUnique identifier for a particular event

Optional Parameters

ParameterTypeRequiredLocationDescription
SendNotificationsBooleanNOQueryWhether to send invited users and attendees a cancellation notification. Set as true or false. Default is true.
InstanceOptionIntegerNOQueryFor a recurring event, which occurrences to delete: 1 = All (default), 2 = Future, 3 = Single.
InstanceStringNOQueryFor a recurring event, the occurrence date the deletion applies to when InstanceOption is 2 or 3. Default: none.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/events/23

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": true
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestEventID in the path is not an integer.Send the event's numeric ID.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.
200 with ResponseData falseEventID is 0, or the event could not be deleted.Check the EventID and the caller's rights on the event.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages