Update Account’s External ID

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

The following table lists and describes the fields required to update an account’s external ID through the UpdateAccountExternalId API:

Field Description

account

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

externalId

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

Request Validations

The following validations are performed when updating an account’s external ID:

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

Update Account’s External ID Example

Use the following request’s body to update an account’s external ID:

{
  "requestId": "{{$guid}}",
  "account": {
    "externalId": "account_external_id"
  },
  "externalId": "new_account_external_id"
}

The outcome of the API call is as follows:

  • The external ID of the account with the old external ID account_external_id is updated to new_account_external_id.

  • The account is no longer accessible using the old external ID account_external_id. The new external ID new_account_external_id must be used to access the account.