Sends notifications

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

The category's id

Body Params

Sends a message to the volunteers for a team, schedules, or serving rotations via email. Text is unavailable for this schedule message type.

files

array of files

the files to attach to the message

subject

string

the subject of the message

body

string

the body of the message

position_ids

array of integers

the position ids to filter volunteers by

position_ids

statuses

array of strings

the statuses to filter volunteers by

statuses

Allowed:

schedule_ids

array of integers

the schedule ids to filter volunteers by

schedule_ids

serving_rotation_ids

array of integers

the serving rotation ids to filter volunteers by

serving_rotation_ids

event_ids

array of integers

the event ids to filter volunteers by

event_ids

excluded_individual_ids

array of integers

individual ids to exclude from the message recipients

excluded_individual_ids

include_public_signups

boolean

Defaults to false

whether to include public signups in the message recipients (cannot be used with serving_rotation_ids)

send_scheduler_copy

boolean

Defaults to false

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

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.

Response

Language

Credentials

OAuth2

Loading…

Response

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

application/json

200Returns the count of messages sent