RIringcentral
Subscriptions

Renew Subscription

Renews the existing subscription (this request comes with empty body).

Please note that WebSocket subscriptions are renewed automatically while websocket session is alive.

post/restapi/v1.0/subscription/{subscriptionId}/renew

Request

Path parameters

subscriptionIdstring required

Internal identifier of a subscription

Response

Subscription renewed successfully

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"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.