ASDinCloudDocs
API ReferenceNotification nodes

Notification nodes

View as Markdown

The notification node object

View as Markdown

Notification nodes define the timing, recipients, and message template for automated notifications.

Attributes

idinteger
Identifier assigned by the API.
scopestring
Use med for medical certificates, doc for documents, birthday for birthdays, or payments for payment reminders.
channelstring
Use email or sms. SMS requires the SMS module and an SMS template.
when_typestring
Unit for the notification timing. Use years, months, weeks, days, or hours.
when_numinteger
Non-negative number of timing units.
template_idinteger
ID of the message template.
birthday_subjectstring
Use athlete, coach, or staff for birthday notifications. Defaults to athlete.
is_activeinteger
1 for active, 0 for inactive.
send_to_subjectinteger
1 if the birthday subject is a recipient, otherwise 0.
cc_emailsarray of strings or null
Additional email addresses.
recipient_maskinteger
Recipient flags as a bit mask. Athlete = 1, parent = 2, coach = 4, staff = 8.
sort_key_secondsinteger
Notification timing converted to seconds for sorting.
tscinteger
Creation time as a Unix timestamp in seconds.
tsuinteger
Last update time as a Unix timestamp in seconds.

List notification nodes

View as Markdown
GET/api/v1/notification_nodes

Lists notification node records in the workspace.

Permissions

Send your API key in X-API-Key. Required permissions are Notification nodes → Read.

Query parameters

scopestring
Filter by med, doc, birthday, or payments.
channelstring
Filter by email or sms.
qstring
Search category and channel.
lengthinteger
Number of records to return.
startinteger
Zero-based offset.
drawstring
Optional request marker echoed in the response.
sortstring
Sort by id, scope, birthday_subject, channel, when_type, when_num, sort_key_seconds, is_active, tsc, or tsu. Prefix the field name with a minus sign for descending order.
orderstring
Direction for unprefixed sort fields. Use asc or desc.

Returns

Each list item includes the template name and its recipient categories, such as genitori for parents.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.

Retrieve a notification node

View as Markdown
GET/api/v1/notification_nodes/{id}

Returns one notification node by ID.

Permissions

Send your API key in X-API-Key. Required permissions are Notification nodes → Read.

Path parameters

idintegerRequired
ID of the notification node.

Returns

The notification node is returned in data.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.
404
The requested record was not found.

Create a notification node

View as Markdown
POST/api/v1/notification_nodes

Creates a notification node.

Permissions

Send your API key in X-API-Key. Required permissions are Notification nodes → Write.

Body parameters

scopestringRequired
Use med for medical certificates, doc for documents, birthday for birthdays, or payments for payment reminders.
channelstringRequired
Use email or sms. SMS requires the SMS module and an SMS template.
when_typestringRequired
Unit for the notification timing. Use years, months, weeks, days, or hours.
when_numintegerRequired
Non-negative number of timing units.
template_idintegerRequired
ID of the message template.
is_activeboolean
Whether this rule is active. Defaults to true when creating it.
send_to_atletiboolean
Target athletes. Alias send_to_athletes.
send_to_genitoriboolean
Target parents. Alias send_to_parents.
send_to_coachboolean
Target coaches. Alias send_to_coaches.
send_to_staffboolean
Target staff.
cc_emailsarray of strings, string, or null
Additional email recipients. A string can separate addresses with commas or semicolons. Use null to clear.
birthday_subjectstring
Use athlete, coach, or staff for birthday notifications. Defaults to athlete.
send_to_subjectboolean
Send a coach or staff birthday notification to that person. Defaults to true.

Provide an eligible recipient. Payment reminders require athletes or parents. For coach or staff birthdays, target the subject or provide additional addresses for email.

Returns

The created notification node is returned in data.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.
400
The request body must be a JSON object.
422
One or more fields failed validation.

Update a notification node

View as Markdown
PATCH / PUT/api/v1/notification_nodes/{id}

Updates a notification node by ID.

Permissions

Send your API key in X-API-Key. Required permissions are Notification nodes → Write.

Path parameters

idintegerRequired
ID of the notification node.

Body parameters

scopestring
Use med for medical certificates, doc for documents, birthday for birthdays, or payments for payment reminders.
channelstring
Use email or sms. SMS requires the SMS module and an SMS template.
when_typestring
Unit for the notification timing. Use years, months, weeks, days, or hours.
when_numinteger
Non-negative number of timing units.
template_idinteger
ID of the message template.
is_activeboolean
Whether this rule is active. Defaults to true when creating it.
send_to_atletiboolean
Target athletes. Alias send_to_athletes.
send_to_genitoriboolean
Target parents. Alias send_to_parents.
send_to_coachboolean
Target coaches. Alias send_to_coaches.
send_to_staffboolean
Target staff.
cc_emailsarray of strings, string, or null
Additional email recipients. A string can separate addresses with commas or semicolons. Use null to clear.
birthday_subjectstring
Use athlete, coach, or staff for birthday notifications. Defaults to athlete.
send_to_subjectboolean
Send a coach or staff birthday notification to that person. Defaults to true.

Omitted fields and recipient switches retain their values.

Provide an eligible recipient. Payment reminders require athletes or parents. For coach or staff birthdays, target the subject or provide additional addresses for email.

Returns

Returns a successful update response.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.
404
The requested record was not found.
400
The request body must be a JSON object.
409
A change to this notification category is already in progress. Retry later.
422
One or more fields failed validation.

Delete a notification node

View as Markdown
DELETE/api/v1/notification_nodes/{id}

Removes a notification rule and cancels its queued notifications.

Permissions

Send your API key in X-API-Key. Required permissions are Notification nodes → Write.

Path parameters

idintegerRequired
ID of the notification node.

Returns

Returns a successful removal response.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.
404
The requested record was not found.
400
The notification rule could not be removed.
409
A change to this notification category is already in progress. Retry later.