Notification Subscriptions

Update a Collection Subscription

Update the notification frequency for a specific collection provider subscription.

Permissions

  • The authenticated user must be the owner of the subscription.
  • Only the frequency attribute can be modified.

Request Body Provide the frequency inside the attributes object. Valid values include:

  • instant: Immediate email notifications.
  • daily: Daily digest emails.
  • none: Disable notifications for this event.

Returns

  • A JSON:API compliant representation of the updated subscription resource.
patch/collection_subscriptions/{subscription_id}/

Request

  • Base URL
    https://api.test.osf.io/v2
  • URL
    https://api.test.osf.io/v2/collection_subscriptions/{subscription_id}/
  • Auth
    none declared

Path parameters

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.

Changes

No recorded changes to this operation across all 2 revisions of this API.