Skip to content

Rename a sub-account​

PUT
/v1/account/subaccount

Requires SUB_ACCOUNTS_MANAGE, granted by TREASURY_WRITE (bundles)

Changes a sub-account's name and responds with 202 and no body. Call it on your primary account (don't send X-VALR-SUB-ACCOUNT-ID); keys limited to some sub-accounts can't use it.

Parameters​

Query Parameters

isProprietarySubAccount

Only matters if VALR has made KYC details mandatory for your sub-accounts: then true changes just the name, and with false the body must also include the account holder's KYC details.

Type
boolean
Exampletrue
Default
false

Request Body​

application/json
JSON
{
"id": 7340032581337088,
"label": "Treasury Reserve"
}

Responses​

Accepted

Samples​

Errors

HTTPErrorWhen
400-113INVALID_JSONThe body isn't valid JSON.
400-11INVALID_REQUESTThe body is empty or a field fails validation (validationErrors lists each failing field), or isProprietarySubAccount isn't true or false.
400-11134SUB_ACCOUNT_NOT_FOUNDNone of your business's sub-accounts has this id.
403-11132SUB_ACCOUNT_ALREADY_EXISTSAnother of your sub-accounts already has this name (ignoring case), or the name is Primary or Main.
409-11423SUB_ACCOUNT_PROFILE_INFO_ALREADY_EXISTSOnly when KYC details are mandatory for your sub-accounts: another of your sub-accounts already has this email address, ID number or cell number.

Plus the errors common to all signed endpoints.