PUT /platform/v1/ens-subscriptions

Overview

Updates a single subscription. To pause an active subscription, set the status request parameter to paused. To unpause a paused subscription, set the status request parameter to active. Always supply a status reason in the request when you update the subscription status. Changes made to a subscription can take up to two minutes to become active.

NameTypeDescription
subscriptionIdstringRequiredUnique identifier for the subscription to update.
eventCategoryTypesarrayRequiredComma-separated list of fully qualified event types for which you’re requesting notifications. Expressed as NotificationEventCategory.NotificationEventType. Review Supported Notification Events for a list of supported event categories and types.
filtersarrayEach string in the array is a key=value pair to filter on. Review Subscription Filters for a list of data items available for filtering.
subscriptionNamestringName of the subscription. This name must be unique.
statusstringIndicates the status of the callback subscription. Can be set to either active or paused. You can only pause active callback subscriptions. You can only make paused callback subscriptions active.
statusReasonstringDescribes why you changed the status.

Usage

Example Request

Example Response

HTTP Responses

ResponseReason
200 OKCallback description updated. Review example response.
304 No ChangeUpdate already exists on the server.
400 Bad RequestInvalid request
403 ForbiddenFailed to pass authorization.
500 Server ErrorInternal error