Sends notifications

post

https://api.ccbchurch.com/scheduling/categories/{id}/notifications

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

The category's id

Body Params

Notifies volunteers via email and text to their scheduling requests.

schedule_ids

array of integers

required

List of schedule IDs to send notifications for

schedule_ids*

event_ids

array of integers

List of event IDs to send notifications for

event_ids

subject

string

Email subject line

message

string

Email message content

notified_status

string

enum

Filter recipients by notification status

Allowed:

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

List of individual IDs to exclude from notifications

excluded_individual_ids

file_ids

array of integers

List of file IDs to attach to the notification

file_ids

Response

200

Returns empty response

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here!