API Reference
  1. One Church Software API
  2. Service Plans

Delete notes in bulk

delete
https://{tenant}.onechurchsoftware.com/api/plans//notes

Remove several plan-level notes. Provide ids, or explicitly set include to false to delete every note matching the filters (and every plan-level note when no filters are given); an empty body is rejected.

Required permission: Full Write Service Plans

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the plan

Query Params
string

Include notes which contain this text.

date-time

Include notes created after this date and time.

date-time

Include notes created before this date and time.

date-time

Include notes last modified after this date and time.

date-time

Include notes last modified before this date and time.

string

Comma-delimited list of note category ids. Values come from /api/plans/servicetypes/{id}/notes/categories.

string

Comma-delimited list of team (group) ids the note applies to.

Body Params

The notes 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
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

OK

401

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

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated about 2 months ago

Did this page help you?