Notification Subscriptions

Update a Preprint Provider Subscription

Updates a preprint provider subscription by setting the values specified in the request body. Unspecified attributes remain unchanged. The subscription can be updated using a PATCH request. The only editable attribute is frequency.

Permissions

User must be authenticated and the owner of the subscription.

Returns

A JSON object containing the updated subscription details.

patch/providers/preprints/{provider_id}/subscriptions/{subscription_id}/

Request

  • Base URL
    https://api.test.osf.io/v2
  • URL
    https://api.test.osf.io/v2/providers/preprints/{provider_id}/subscriptions/{subscription_id}/
  • Auth
    none declared

Path parameters

provider_idstring required

The unique identifier of the preprint provider.

subscription_idstring required

The unique identifier of the subscription.

Request body

object required

Example request

{
  "data": {
    "type": "notification_subscriptions",
    "id": "provider123_subscription456",
    "attributes": {
      "frequency": "email_digest"
    }
  }
}

Response

OK

Changes

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