v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Staff Notification Setting

createOrganizationStaffNotificationSetting

Create a Staff Notification Setting for an Organization

post/organizations/{id}/staff-notification-settings

Path parameters

idinteger required
Example:82364

Primary identifier of Organization

Request body

scope_type'Organization_Manager'

Scope for email notifications

scope_idinteger

Scope ID will be Organization ID as the scope type is Organization_Manager

member_idinteger

Member who created Staff Notification Setting

chargebacks_categoryboolean

Receive an email if a Supporter files a chargeback and if it’s won or lost.

classy_pay_categoryboolean

Sent when your Organization's payout report is available

fundraising_page_categoryboolean

Receive an email when a Supporter creates a Fundraising Page or Team.

recurring_canceled_categoryboolean

Receive an email when a Recurring Plan is canceled.

recurring_ended_categoryboolean

Receive an email when a Recurring Plan has ended.

recurring_failed_categoryboolean

Receive an email when a Recurring Donation fails.

recurring_modified_categoryboolean

Receive an email when a Recurring Plan has been updated.

recurring_new_categoryboolean

Receive an email when a new Recurring Plan has been created.

recurring_successful_categoryboolean

Receive an email when a Recurring Donation has been made.

transactions_categoryboolean

Receive an email for every donation, ticket/registration purchase.

Example request

{
  "scope_type": "Organization_Manager",
  "scope_id": 82364,
  "member_id": 2012,
  "chargebacks_category": true,
  "fundraising_page_category": true,
  "transactions_category": true
}

Response

Success

member_idinteger

Member who created Staff Notification Setting

chargebacks_categoryboolean

Receive an email if a Supporter files a chargeback and if it’s won or lost.

classy_pay_categoryboolean

Sent when your Organization's payout report is available

fundraising_page_categoryboolean

Receive an email when a Supporter creates a Fundraising Page or Team.

recurring_canceled_categoryboolean

Receive an email when a Recurring Plan is canceled.

recurring_ended_categoryboolean

Receive an email when a Recurring Plan has ended.

recurring_failed_categoryboolean

Receive an email when a Recurring Donation fails.

recurring_modified_categoryboolean

Receive an email when a Recurring Plan has been updated.

recurring_new_categoryboolean

Receive an email when a new Recurring Plan has been created.

recurring_successful_categoryboolean

Receive an email when a Recurring Donation has been made.

transactions_categoryboolean

Receive an email for every donation, ticket/registration purchase.

idinteger

Primary identifier of Staff Notification Setting

created_atstring date-time

Date/time of initial Staff Notification Setting creation

updated_atstring date-time

Date/time of Staff Notification Setting last updated

scope_type'Organization_Manager'

Scope for email notifications

scope_idinteger

Scope ID will be Organization ID as the scope type is Organization_Manager

Example response

{
  "member_id": 2012,
  "chargebacks_category": true,
  "fundraising_page_category": true,
  "transactions_category": true,
  "id": 21003,
  "created_at": "2019-04-23T10:25:03Z",
  "updated_at": "2019-04-23T10:25:03Z",
  "scope_type": "Organization_Manager",
  "scope_id": 82364
}