Skip to main content
PUT
/
platform
/
admin
/
custodians
/
{id}
/
is_active
Update custodian active status
curl --request PUT \
  --url https://api.example.com/platform/admin/custodians/{id}/is_active
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

Modifies the active status of a custodian provider. When set to inactive, the custodian will stop synchronizing wallets and cannot be used for new operations. Existing wallets remain but are not updated.

​
Input

  • id (long, required) — The unique identifier of the custodian.
  • value (bool, required) — New active status (true = active, false = inactive).

​
Output

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

​
Examples

Request 
PUT /api/platform/custodians/42/is-active?value=false
Response (200 OK) 
{
  "data": {
    "success": true,
    "message": "Custodian active status updated successfully"
  },
  "isSuccess": true
}

​
Errors

  • 400 Bad Request: Invalid custodian ID or status value.
  • 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

Deactivating a custodian does not delete its wallets but prevents further synchronization. This is useful for temporarily disabling a provider without losing data.

Path Parameters

​
id
integer<int64>
required

The unique identifier of the custodian to update.

Query Parameters

​
value
boolean

The new active status (true for active, false for inactive).

​
api-version
string | null

Response

Custodian active status 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 }