Skip to main content
PUT
/
platform
/
admin
/
custodians
/
{id}
/
account_name
Update custodian account name
curl --request PUT \
  --url https://api.example.com/platform/admin/custodians/{id}/account_name \
  --header 'Content-Type: application/json' \
  --data '
{
  "custodianId": 42,
  "accountName": "Alpha Treasury Desk"
}
'
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

Modifies the display name (account name) of a custodian. This is a user-friendly identifier used in the platform UI and reports to distinguish between multiple custodian configurations.

​
Input

Expects a JSON body containing:
  • custodianId (long, required) — The unique identifier of the custodian (auto-populated from route).
  • accountName (string, required) — The new display name for the custodian account.

​
Output

Returns a response object containing:
  • success (bool) — Whether the update was successful.
  • message (string) — Confirmation message.

​
Examples

Request 
PUT /api/platform/custodians/42/account-name

{
  "accountName": "Production Treasury - Updated"
}
Response (200 OK) 
{
  "data": {
    "success": true,
    "message": "Account name updated successfully"
  },
  "isSuccess": true
}

​
Errors

  • 400 Bad Request: Invalid payload or account name exceeds maximum length.
  • 401 Unauthorized: Authentication required but not provided.
  • 403 Forbidden: Caller does not have permission to update custodians.
  • 404 Not Found: Custodian with specified ID does not exist.
  • 500 Internal Server Error: Unexpected error occurred during update.

​
Notes

The account name is purely for display and identification purposes. It does not affect the connection to the external custodian provider or any technical configuration.

Path Parameters

​
id
integer<int64>
required

The unique identifier of the custodian to update.

Query Parameters

​
api-version
string | null

Body

application/json

The request containing the new account name.

Request to rename a custodian account.

​
custodianId
integer<int64>

Identifier of the custodian to rename.

Example:

42

​
accountName
string

New account name to assign to the custodian.

Example:

"Alpha Treasury Desk"

Response

Account name updated successfully.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.

Example:
{ "success": true }