Update Subscription’s Custom Name

The UpdateSubscriptionCustomName API in OCS.io facilitates the modification of a subscription’s custom name, allowing for customization to address specific operational needs.

Please note that attributes are not versioned, meaning that when you update subscription information, the new values take effect immediately. This change does not impact previously processed data.

API Overview

Fields Required for Updating Subscription’s Custom Name

The following table lists and describes the fields required to update a subscription’s custom name through the UpdateSubscriptionCustomName API:

Field Description

subscription

ID (Ref ID / External ID) of the Subscription.

customName

New Custom Name of the Subscription.
Detailed API documentation and endpoint specifics are available here.

Request Validations

The following validations are performed when updating a subscription’s custom name:

Update Subscription’s Custom Name Example

Use the following request’s body to update a subscription’s custom name:

{
  "requestId": "{{$guid}}",
  "subscription": {
    "externalId": "subscription_external_id"
  },
  "customName": "Demo Subscription updated"
}

The outcome of the API call is as follows:

  • The custom name of the subscription with external ID subscription_external_id is updated to Demo Subscription updated.