Delete events

delete

https://{tenant}.onechurchsoftware.com/api/events

Delete events in bulk. Provide ids, or explicitly set include to false to delete every event matching the query filters (and every event outright when no filters are given); an empty body is rejected. Events synced from eSPACE are skipped. Set parent to true to also delete the entire repeating series of each selected event.

Required permission: Full Write Events

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Returns events where the name contains the given text.

calendar

string

Comma-delimited list of calendar ids. Values come from /api/calendars.

campus

string

Comma-delimited list of campus ids. Use -1 to include events without a campus. Values come from /api/locations.

filter

string

Free text search across event content.

Body Params

Details on what to delete.

ids

array of doubles | null

The ids the operation applies to: an include list by default, or an exclude list when include is false. For deletes, required unless include is false.

ids

include

boolean | null

Whether ids is an include list (true, default) or an exclude list (false). Setting include to false with no ids applies the operation to every record matching the query filters.

parent

boolean | null

When true, deletes the entire repeating series (the parent and all of its occurrences) of each selected event.

Responses

200

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.