Update Account’s Custom Name

The UpdateAccountCustomName API in OCS.io facilitates the modification of an account’s custom name, allowing for customization to address specific operational needs.

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

API Overview

Fields Required for Updating Account’s Custom Name

The following table lists and describes the fields required to update an account’s custom name through the UpdateAccountCustomName API:

Field Description

account

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

customName

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

Request Validations

The following validations are performed when updating an account’s custom name:

  • Account 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 Account’s Custom Name Example

Use the following request’s body to update an account’s custom name:

{
  "requestId": "{{$guid}}",
  "account": {
    "externalId": "account_external_id"
  },
  "customName": "Demo Account updated"
}

The outcome of the API call is as follows:

  • The custom name of the account with external ID account_external_id is updated to Demo Account updated.