Sign in

v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB
Notification Subscriptions

Update a Notification Subscription

Update the notification frequency for a specific subscription. Only the frequency attribute can be modified.

Permissions

  • The authenticated user must be the owner of the subscription.

Request Body

Provide the frequency attribute within the attributes object to update the subscription. Available values for frequency are:

  • instant: Receive immediate email notifications.
  • daily: Receive a daily summary email.
  • none: Disable email notifications for this subscription.

Returns

  • A JSON object with the updated subscription details under the data key if the update is successful. - If unsuccessful, returns an errors object detailing the validation issues.
patch/subscriptions/{subscription_id}/

Path parameters

subscription_idstring required

The unique identifier of the notification subscription.

Request body

Example request

{
  "data": {
    "type": "subscription",
    "id": "{subscription_id}",
    "attributes": {
      "frequency": "daily"
    }
  }
}

Response

Subscription successfully updated.