/editAdministrativePolicy

1 min

POST

This API allows associating different action types to the corresponding approval workflows.

The order of the actions in the list defines their importance - from the most important to the less important, i.e. if the user did several actions in one session, the chosen approval workflow will be the one associated with the most important action (the one that appears first in the list).

Request Example:

.. code-block::

editAdministrativePolicy( actions=[ { action_type=4, approval_workflow_id="123" }, { action_type=3, approval_workflow_id="321" }, { action_type=5, approval_workflow_id="123" } ], request_extra_data={ "message_number": 5, "session_id": "3478593863424051983840947" } )

Response Example:

.. code-block::

{
    "FunctionData": {
        "StatusCode": 0,
        "StatusCodeDescription": "Policy edited successfully"
    },
    "Meta": {
        "AccessToken": "2911...9a7",
        "Destination": "04bc...9e2",
        "Source": "3dcf...ba4",
        "Time": "2025-05-22 17:00:44.605"
    }
}

Error Responses

Error Type	Http Code	GK8 error code	Reason / Description	Example Response
Backend Response	400	1	Too many actions	"StatusCode": 1
Backend Response	400	2	Duplicate action type	"StatusCode": 2, "ActionType": 100001
Backend Response	400	3	Not enough actions	"StatusCode": 3
Backend Response	400	4	Unknown actions	"StatusCode": 4, "ActionTypes": [21232, 3112]
Backend Response	400	5	Unknown approval workflows	"StatusCode": 5, "ApprovalWorkflowIds": ["6", "9"]
Backend Response	400	6	Approval workflow has an invalid type	"StatusCode": 6, "ApprovalWorkflowIds": ["1", "2"]
Backend Response	400	7	Users are managed externally	"StatusCode": 7

actionsarray<p>a list of 'Action' objects (Action class is defined in apiclient/MpcDriven/Action.py). It must include all the different action types defined in apiclient/MpcDriven/Action.py. For example: actions = [Action(ActionType.CREATE_OR_UPDATE_USER_MANAGEMENT, "1"), Action(ActionType.CREATE_OR_UPDATE_ADDRESS_GROUPS_AND_CONTACTS, "2"), Action(ActionType.COINS_MANAGEMENT, "1"), Action(ActionType.CREATE_OR_UPDATE_APPROVAL_WORKFLOW_AND_POLICY, "1")] In this case, the most important action is CREATE_OR_UPDATE_USER_MANAGEMENT, the next one is create_or_update_address_groups_and_contacts, etc...</p>

request_extra_dataobjectadditional data for the administrative request

acceptstringGenerated from available response content types

bodyobject

200success

curl --request POST \
     --url '/editAdministrativePolicy?actions=array&request_extra_data=%22None%22' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "FunctionData": {
     "RequestExtraData": {
     "MessageNumber": 5,
     "SessionId": "3478593863424051983840947"
     }
     },
     "Meta": {
     "FunctionName": "editAdministrativePolicy",
     "RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
     "Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
     "Time": "2021-02-07T18:37:46.948Z",
     "Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
     "AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
     }
     }'