Sends schedule notification for open positions

post

https://api.ccbchurch.com/scheduling/schedules/{id}/open_schedule_notifications

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

The schedule id

Body Params

Notifies volunteers about open positions they can sign up for in a schedule.

subject

string

The subject line for the notification email

message

string

The message that will be sent to volunteers in the recipient list. Required when dry_run is false.

dry_run

boolean

Defaults to true

deprecated

If this is set to true the emails will not be sent. Dry run is now deprecated, it's recommended to use the getNotificationMetrics endpoint instead.

excluded_individual_ids

array of integers

Defaults to []

Pass in an array of individual ids that represent who should not be included in the recipient list.

excluded_individual_ids

file_ids

array of integers

Defaults to []

Array of file IDs to attach to the notification

file_ids

send_scheduler_copy

boolean

Defaults to false

When true, a preview email will be sent to the scheduler only.

Responses

400

Schedule must be opened to notify volunteers

403

Do not have the permission to access

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Returns the count of messages sent