put
https://api.zenoti.com//v1/memberships/bulk_notifications
This API validates all request items first and processes only the valid ones.
TriggerMembershipNotificationsRequest
| Json Property | Data Type | Description |
|---|---|---|
| notification_items | List | Collection of notification items to be processed. Each item represents a membership notification to create or reinsert. |
NotificationItem
| Json Property | Data Type | Description |
|---|---|---|
| action_type | MembershipNotificationActions (nullable) | Membership action associated with the notification. Used to derive the notification type if notification_type is not provided. Accepts enum name or numeric value. |
| notification_type | int (nullable) | Numeric identifier for the notification type. If provided, it takes priority over action_type. |
| notification_channel | NotificationChannel (nullable) | Channel through which the notification will be sent. Defaults to ALL if not provided. |
| invoice_item_id | Guid (nullable) | Invoice item identifier associated with the notification. Required for certain notification types such as SignUp. |
| user_membership_id | Guid (nullable) | Identifier of the user's membership associated with the notification. Required for most membership actions. |
| center_id | Guid | Identifier of the center where the membership action occurred. This field is mandatory. |
| reference_id | Guid (nullable) | Reference identifier used to reinsert an existing notification. If null, a new notification is created. |
| failure_reason | string | Description of the validation failure when the item cannot be processed. Included only in failed response items. |
TriggerMembershipNotificationsResponse
| Json Property | Data Type | Description |
|---|---|---|
| processed_count | int | Number of notification items successfully processed. |
| failed_count | int (nullable) | Number of notification items that failed validation or processing. Returned only when failures occur. |
| failed_items | List (nullable) | List of notification items that failed validation, including the reason for failure. |
| error | APIV2ErrorModel (nullable) | Error object returned when the request fails completely or encounters a server error. |
MembershipNotificationActions (Enum)
| Json Property | Data Type | Description |
|---|---|---|
| Upgrade | int (0) | Notification triggered when a membership is upgraded. |
| Downgrade | int (1) | Notification triggered when a membership is downgraded. |
| Transfer | int (2) | Notification triggered when a membership is transferred. |
| Cancel | int (3) | Notification triggered when a membership is canceled. |
| Freeze | int (4) | Notification triggered when a membership is frozen. |
| SignUp | int (5) | Notification triggered when a membership is created or signed up. |
| AddOnMemberSignup | int (6) | Notification triggered when an add-on member signs up. |
| AddOnMemberFreeze | int (9) | Notification triggered when an add-on member membership is frozen. |
| AddOnMemberCancel | int (10) | Notification triggered when an add-on member membership is canceled. |
| ChangePaymentMethod | int (12) | Notification triggered when the primary payment method is changed. |
| ChangeBackupPayment | int (13) | Notification triggered when the backup payment method is changed. |
NotificationChannel (Enum)
| Json Property | Data Type | Description |
|---|---|---|
| SMS | int (0) | Notification is sent via SMS. |
| int (1) | Notification is sent via email. | |
| PUSH | int (2) | Notification is sent as a push notification. |
| int (5) | Notification is sent via WhatsApp. | |
| ALL | int (-1) | Notification is sent through all available channels. Default value when not specified. |