/editSystemPreferences

1 min

POST

This API allows to update settings that impact the entire system i.e. all users.

    -------------------- Request --------------------

            editSystemPreferences(
                   system_preferences={
                        aml_provider=0,
                        collector={
                              user_ids=["[email protected]", "[email protected]"],
                              fee_limit="1000000"
                            },
                        transaction_approval_timeout=300,
                        allowSendLogs=true,
                        metamask_additional_approver=true,
                        tx_risk_assess_provider="Blockaid"
                        },
                    request_extra_data={
                      "message_number": 5,
                      "session_id": "3478593863424051983840947"
                   )

    -------------------- Response --------------------

            {
            "FunctionData": {
                "StatusCode": 0,
                "StatusCodeDescription": "Edited system preferences successfully"
            },
            "Meta": {
                "AccessToken": "e59612cdcb1242af750f4f8cc9032a4d44bfdb40b00bd19c5e5ef5d538fc74a0",
                "Destination": "0473aa0362d3998baab6880822e838133a061c379b8e146bcded46deb4805aa83139a3c578293161bca7926e53ef20888977f4030c38d42aae10b36c3309c0f766",
                "Source": "762b6aa122a0ba22557a0cf5ea0c49953e64f7485ffb7857f26541f748e36e83b2e4cca777569511214fcf68f3301a322bbdf15e7479ae0d695fcf40c30a81ff56",
                "Time": "2025-09-30 15:25:43.678"
            }
        }

Error Responses

Error Type	Http Code	GK8 error code	Reason / Description	Example Response
Backend Response	400	1	AML provider not supported	"StatusCode": 1
Backend Response	400	2	Chainalysis provider not supported on test	"StatusCode": 2
Backend Response	400	3	Unknown user	"StatusCode": 3, "UserIds": ["[email protected]", "[email protected]"]
Backend Response	400	4	Duplicate user	"StatusCode": 4, "UserId": "[email protected]"
Backend Response	400	5	Collector fee limit is invalid (not a non-negative integer)	"StatusCode": 5
Backend Response	400	6	Transaction approval timeout is invalid (not a positive integer or exceeds two-day limit)	"StatusCode": 6
Backend Response	400	7	Transaction risk assessment provider not supported	"StatusCode": 7

system_preferencesobject<p>see MpcDriven/SystemPreferences.py for examples on how to utilize this class</p>

request_extra_dataobject<p>additional data for the administrative request (currently used only for administrative requests)</p>

acceptstringGenerated from available response content types

bodyobject

200success

curl --request POST \
     --url '/editSystemPreferences?system_preferences=%22None%22&request_extra_data=%22None%22' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "FunctionData": {
     "AllowSendLogs": true,
     "Collector": {
     "FeeLimit": "100000000"
     },
     "MetamaskAdditionalApprover": true
     },
     "Meta": {
     "FunctionName": "editSystemPreferences",
     "RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
     "Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
     "Time": "2021-02-07T18:37:46.948Z",
     "Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
     "AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
     }
     }'