Bulk delete forms

delete

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

Delete several forms at once, along with all of their entries. Provide ids, or explicitly set include to false to delete every form matching the filters (and every form outright when no filters are given); an empty body is rejected. Built-in forms cannot be deleted.

Required permission: Full Write Forms

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Return forms whose name contains the given text.

description

string

Return forms whose description contains the given text.

active

boolean

Whether the form is currently active. A form is active when it has no expiration date or the date has not passed yet.

category

string

Comma-delimited list of category ids. Use -1 to include forms with no category. Values come from /api/property_values/form_categories/values.

linked

boolean

Whether the form serves as the sign-up form for a group, event, or position. Linked forms cannot be filled out directly.

featured

boolean

Whether the form is featured.

submissions.start

double

Return forms with at least this many submissions.

submissions.end

double

Return forms with at most this many submissions.

events.start

double

Return forms used by at least this many events.

events.end

double

Return forms used by at most this many events.

groups.start

double

Return forms used by at least this many groups.

groups.end

double

Return forms used by at most this many groups.

positions.start

double

Return forms used by at least this many positions.

positions.end

double

Return forms used by at most this many positions.

earliest.start

date-time

Return forms whose first submission was on or after this date.

earliest.end

date-time

Return forms whose first submission was on or before this date.

latest.start

date-time

Return forms whose latest submission was on or after this date.

latest.end

date-time

Return forms whose latest submission was on or before this date.

filter

string

Full-text search text. Matching forms are returned ranked by relevance.

Body Params

The ids 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.

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!