Bulk delete coupons

delete

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

Delete several of the given form's coupons at once. Provide ids, or explicitly set include to false to delete every coupon matching the filters (and every coupon outright when no filters are given); an empty body is rejected. Coupons that have been used by an entry are not deleted.

Required permission: Full Write Forms

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

form

int32

required

≥ 1

The id of the form.

Query Params

name

string

Return coupons whose name contains the given text.

active

boolean

Whether the coupon is currently active.

auto

boolean

Whether the coupon applies automatically (true) or requires a code (false).

description

string

Return coupons whose description contains the given text.

code

string

Return coupons whose code contains the given text.

discount.start

double

Return coupons discounting at least this amount.

discount.end

double

Return coupons discounting at most this amount.

start.start

date-time

Return coupons becoming valid on or after this date.

start.end

date-time

Return coupons becoming valid on or before this date.

end.start

date-time

Return coupons expiring on or after this date.

end.end

date-time

Return coupons expiring on or before this date.

criteria

string

Comma-delimited list of eligibility criteria ids: 1 = all items, 2 = any item from a given list, 3 = all items from a given list.

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.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

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! Or choose an example:

text/plain

application/json

text/json

404Not Found