Notification Subscriptions
Update a Registration Provider Notification Subscription
Update a specific notification subscription associated with a registration provider. Typically, this endpoint is used to change the notification frequency for the subscription.
Permissions
- The requesting user must be authenticated.
- The requesting user must be the owner of the subscription.
Unauthorized or forbidden access attempts will result in 401 Unauthorized or 403 Forbidden errors.
Request Body Provide the subscription ID and the updated frequency attribute.
Available Frequency Values
- instant: Immediate email notifications.
- daily: Daily summary emails.
- none: No notifications.
Returns A JSON object representing the updated subscription.
patch/providers/registrations/{provider_id}/subscriptions/{subscription_id}/
Path parameters
provider_idstring required
The unique identifier of the registration provider associated with this subscription.
subscription_idstring required
The unique identifier of the notification subscription.
Request body
Example request
{
"data": {
"type": "subscription",
"id": "reg123_subscription456",
"attributes": {
"frequency": "daily"
}
}
}Response
Subscription successfully updated.