Skip to main content

Update Platform Owner Can Change Wallet

Turns the platform setting platform_owner_can_change_wallet on or off. The value is copied onto every setup when the setup is created and deployed into its diamond, and Start Platform Owner Change checks that copy. Changing the setting therefore only affects setups created afterwards; existing setups keep the value they were created with.

Only the platform owner's API key may call this endpoint; any other key gets 403.

Required permission: platform-setting:update

Request​

PATCH /v2/admin/platform-settings/platform-owner-can-change-wallet

Headers​

NameDescription
AuthorizationRequired. Bearer <access_token>
Content-TypeRequired. application/json

Body​

FieldTypeRequiredDescription
platform_owner_can_change_walletbooleanNoThe new value. An omitted field is read as false, so always send it.

Example​

curl --request PATCH \
--url '{{baseUrl}}/v2/admin/platform-settings/platform-owner-can-change-wallet' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"platform_owner_can_change_wallet": true
}'

Response​

204 No Content, no body.

Errors​

StatusCodeDescription
40010015The body could not be read (for example a non-boolean value)
40310005The API key does not belong to the platform owner

See Errors for the error format and common codes.