Sign in

v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB
Subscriptions

Update Subscription

Updates the existing subscription. The client application can extend or narrow the list of events for which it receives notifications within the current subscription. If event filters are specified, calling this method modifies them for the existing subscription. The method also allows one to set an expiration time for the subscription itself.

If parameters other than events and expiresIn are specified in the request they will be ignored. If the request body is empty then the specified subscription will be renewed without any event filter modifications and using the default expiration time.

If the request is sent with empty body, it just renews a subscription (so it is an equivalent of the POST /restapi/v1.0/subscription/{subscriptionId}/renew).

Please note that WebSocket subscriptions cannot be updated via HTTP interface.

put/restapi/v1.0/subscription/{subscriptionId}

Path parameters

subscriptionIdstring required

Internal identifier of a subscription

Request body

eventFiltersstring[] required

The list of event filters corresponding to events the user is subscribed to

expiresIninteger

Subscription lifetime in seconds. The maximum subscription lifetime depends upon the specified transportType:

Transport typeMaximum permitted lifetime
WebHook315360000 seconds (10 years)
RC/APNS, RC/GSM7776000 seconds (90 days)
PubNub900 seconds (15 minutes)
WebSocketn/a (the parameter is ignored)

Example request

{
  "expiresIn": 1200
}

Response

Successful response

uristring uri required

Canonical URI of a subscription resource

idstring required

Internal identifier of a subscription

eventFiltersstring[] required

The list of event filter names corresponding to events the user is subscribed to

expirationTimestring date-time required

Subscription expiration time in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z

expiresIninteger

Subscription lifetime in seconds

status'Active' | 'Blacklisted' required

Subscription status

creationTimestring date-time required

Subscription creation time in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534

Example response

{
  "id": "95fecfc9-9cdc-4e94-a78a-89fd65889d37",
  "deliveryMode": {
    "address": "https://acme.com/myservice/webhook"
  }
}