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

Save plan settings

put
https://{tenant}.onechurchsoftware.com/api/plans//settings

Replace the plan's reminder, change request, and sign-up settings. First retrieve the current settings from GET /api/plans/{id}/settings, apply your changes, then send back the full object. Reminders that are omitted are disabled.

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

Body Params

The plan's settings

reminders
object | null

The plan's serving and response reminders. Reminders that are omitted are disabled.

requests
object | null

Whether volunteers may request changes to their assignments, and until how many days before the plan. Defaults to enabled, 3 days, when omitted.

signup
array of objects | null

The sign-up rules for each of the plan's teams.

signup
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
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! Or choose an example:
text/plain
application/json
text/json

Updated about 2 months ago

Did this page help you?