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. Accepts the same filters as the events search endpoint, so a filtered delete removes exactly the events that search returns.

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.

description

string

Returns events where the description contains the given text.

date.start

date-time

Include events starting on or after this date (the church's timezone; time of day is ignored).

date.end

date-time

Include events starting on or before this date (the church's timezone; time of day is ignored).

active

boolean

If true, returns today's and future events. If false, returns events that have passed.

listed

boolean

Whether to return events that are currently set as listed.

calendar

string

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

campus

string

Comma-delimited list of campus ids. Events without a campus are always included. Values come from /api/locations.

organizer

int32

≥ 1

The person id of an organizer whose events should be returned.

registration

boolean

Whether to return events which require registration or not.

trackAttendance

boolean

Whether to return events which are tracking attendance via the check-in system.

category

string

Comma-delimited list of category ids. Values come from /api/property_values/event_types/values.

period

string

Returns events matching the given time period, overriding date.start and date.end. Accepted values are: today, tomorrow, this_week, next_week, this_month, next_month.

group

int32

≥ 1

If set, returns events on the given group's calendar.

event

int32

≥ 1

The parent event id. If set, returns all child occurrences under the parent event.

featured

boolean

Whether to return only featured events (true) or only non-featured events (false).

form

int32

The id of a sign-up form. Use -1 to include only events without a sign-up form. Values come from /api/forms.

public

boolean

Whether the event is visible to the public (inherited from its calendar).

filter

string

Free text search across event content. When set, results are returned in relevance order.

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.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here!