Update Subscriber’s External ID

The UpdateSubscriberExternalId API in OCS.io facilitates the modification of a subscriber’s external ID, 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 External ID

The following table lists and describes the fields required to update a subscriber’s external ID through the UpdateSubscriberExternalId API:

Field Description

subscriber

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

externalId

New External ID of the Subscriber.
Detailed API documentation and endpoint specifics are available here.

Request Validations

The following validations are performed when updating a subscriber’s external ID:

  • Subscriber must be provided in the request, it must be already created in the system and must not be in Deactivated State.

  • External ID must be provided in the request, it must be unique and must not be already assigned to another Subscriber even in Deactivated State.

Update Subscriber’s External ID Example

Use the following request’s body to update a subscriber’s external ID:

{
  "requestId": "{{$guid}}",
  "subscriber": {
    "externalId": "subscriber_external_id"
  },
  "externalId": "new_subscriber_external_id"
}

The outcome of the API call is as follows:

  • The external ID of the subscriber with the old external ID subscriber_external_id is updated to new_subscriber_external_id.

  • The subscriber is no longer accessible using the old external ID subscriber_external_id. The new external ID new_subscriber_external_id must be used to access the subscriber.