Skip to main content
PUT
/
tenant
/
{tenantId}
/
custodians
/
{id}
/
sync_settings
Updates the synchronization settings applied to custodian wallets.
curl --request PUT \
  --url https://api.example.com/tenant/{tenantId}/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"
  }
}

Path Parameters

​
tenantId
integer<int64>
required

Identifier of the tenant that owns the custodian.

​
id
integer<int64>
required

Identifier of the custodian to update.

Body

application/json

Payload describing the synchronization flags to apply.

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

200 - application/json

Returned when the synchronization preferences are 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 }