v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB
Notification Subscriptions

Update a Collection Provider Notification Subscription

Update the notification frequency for a specific subscription associated with a collection provider.

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 Frequency Values:

  • instant: Immediate email notifications.
  • daily: Daily summary emails.
  • none: Disable email notifications.

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/providers/collections/{provider_id}/subscriptions/{subscription_id}/

Path parameters

provider_idstring required

The unique identifier of the collection provider.

subscription_idstring required

The unique identifier of the notification subscription.

Request body

Example request

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

Response

Subscription successfully updated.