Update Customer’s Custom Name

The UpdateCustomerCustomName API in OCS.io facilitates the modification of a customer’s custom name, 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 Custom Name

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

Field Description

customer

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

customName

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

Request Validations

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

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

  • Custom Name must be provided in the request.

Update Customer’s Custom Name Example

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

{
  "requestId": "{{$guid}}",
  "customer": {
    "externalId": "customer_external_id"
  },
  "customName": "Demo Customer updated"
}

The outcome of the API call is as follows:

  • The custom name of the customer with external ID customer_external_id is updated to Demo Customer updated.