Update Customer’s External ID

The UpdateCustomerExternalId API in OCS.io facilitates the modification of a customer’s external ID, allowing for customization to address specific operational needs.

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

API Overview

Fields Required for Updating Customer’s External ID

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

Field Description

customer

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

externalId

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

Request Validations

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

  • Customer 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 Customer even in Deactivated State.

Update Customer’s External ID Example

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

{
  "requestId": "{{$guid}}",
  "customer": {
    "externalId": "customer_external_id"
  },
  "externalId": "new_customer_external_id"
}

The outcome of the API call is as follows:

  • The external ID of the customer with external ID customer_external_id is updated to new_customer_external_id.

  • The customer is no longer accessible using the old external ID customer_external_id. The new external ID new_customer_external_id must be used to access the customer.