Update Subscriber’s Custom Name

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

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

API Overview

Fields Required for Updating Subscriber’s Custom Name

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

Field Description

subscriber

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

customName

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

Request Validations

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

Update Subscriber’s Custom Name Example

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

{
  "requestId": "{{$guid}}",
  "subscriber": {
    "externalId": "subscriber_external_id"
  },
  "customName": "Demo Subscriber updated"
}

The outcome of the API call is as follows:

  • The custom name of the subscriber with external ID subscriber_external_id is updated to Demo Subscriber updated.