Skip to main content
PUT
/
platform
/
admin
/
custodians
/
{id}
/
sync_settings
Update wallet sync settings
curl --request PUT \
  --url https://api.example.com/platform/admin/custodians/{id}/sync_settings \
  --header 'Content-Type: application/json' \
  --data '
{
  "custodianId": 42,
  "walletsSyncIsVisibleWallet": true,
  "walletsSyncIsActiveWallet": true,
  "walletsSyncIsActiveCustodialRelationship": true,
  "walletsSyncIsActiveTreasuryWallets": false
}
'
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

Modifies the default synchronization settings for a custodian. These settings are applied to newly imported wallets during synchronization operations, controlling their visibility, active status, custodial relationship, and treasury wallet capabilities.

​
Input

Expects a JSON body containing:
  • custodianId (long, required) — The unique identifier of the custodian (auto-populated from route).
  • walletsSyncIsVisibleWallet (bool, required) — Whether synchronized wallets are visible in the platform UI.
  • walletsSyncIsActiveWallet (bool, required) — Whether synchronized wallets are active and can perform operations.
  • walletsSyncIsActiveCustodialRelationship (bool, required) — Whether the custodial relationship is active for synchronized wallets.
  • walletsSyncIsActiveTreasuryWallets (bool, required) — Whether treasury wallet features are enabled for synchronized wallets.

​
Output

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

​
Examples

Request 
PUT /api/platform/custodians/42/sync-settings

{
  "walletsSyncIsVisibleWallet": true,
  "walletsSyncIsActiveWallet": true,
  "walletsSyncIsActiveCustodialRelationship": true,
  "walletsSyncIsActiveTreasuryWallets": false
}
Response (200 OK) 
{
  "data": {
    "success": true,
    "message": "Wallet synchronization settings updated successfully"
  },
  "isSuccess": true
}

​
Errors

  • 400 Bad Request: Invalid payload or missing required fields.
  • 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

These settings only affect newly synchronized wallets. Existing wallets retain their current settings. Use this endpoint to configure default behavior for future wallet imports from the custodian provider.

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 wallet synchronization settings.

Request to update synchronization preferences for custodian wallets.

​
custodianId
integer<int64>

Identifier of the custodian whose synchronization settings are being updated.

Example:

42

​
walletsSyncIsVisibleWallet
boolean

Default visibility status for synchronized wallets.

Example:

true

​
walletsSyncIsActiveWallet
boolean

Default active status for synchronized wallets.

Example:

true

​
walletsSyncIsActiveCustodialRelationship
boolean

Default custodial relationship status for synchronized wallets.

Example:

true

​
walletsSyncIsActiveTreasuryWallets
boolean

Default active status for synchronized treasury wallets.

Example:

false

Response

Synchronization settings 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 }