Update Policy

Update an existing Policy

POST

/

public

/

v1

/

submit

/

update_policy

Authorizations

API Key

X-Stamp

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_UPDATE_POLICY_V2

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

parameters field

Show details

parameters.policyId

string

required

Unique identifier for a given Policy.

parameters.policyName

string

Human-readable name for a Policy.

parameters.policyEffect

enum<string>

Enum options: EFFECT_ALLOW, EFFECT_DENY

parameters.policyCondition

string

The condition expression that triggers the Effect (optional).

parameters.policyConsensus

string

The consensus expression that triggers the Effect (optional).

parameters.policyNotes

string

Accompanying notes for a Policy (optional).

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.updatePolicyIntentV2

object

required

The updatePolicyIntentV2 object

Show updatePolicyIntentV2 details

activity.intent.updatePolicyIntentV2.policyId

string

required

Unique identifier for a given Policy.

activity.intent.updatePolicyIntentV2.policyName

string

Human-readable name for a Policy.

activity.intent.updatePolicyIntentV2.policyEffect

enum

policyEffect field

Enum options: EFFECT_ALLOW, EFFECT_DENY

activity.intent.updatePolicyIntentV2.policyCondition

string

The condition expression that triggers the Effect (optional).

activity.intent.updatePolicyIntentV2.policyConsensus

string

The consensus expression that triggers the Effect (optional).

activity.intent.updatePolicyIntentV2.policyNotes

string

Accompanying notes for a Policy (optional).

activity.result

object

required

The result of the activity

Show result details

activity.result.updatePolicyResultV2

object

required

The updatePolicyResultV2 object

Show updatePolicyResultV2 details

activity.result.updatePolicyResultV2.policyId

string

required

Unique identifier for a given Policy.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/update_policy \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_UPDATE_POLICY_V2",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "policyId": "<string>",
        "policyName": "<string>",
        "policyEffect": "<EFFECT_ALLOW>",
        "policyCondition": "<string>",
        "policyConsensus": "<string>",
        "policyNotes": "<string>"
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UPDATE_POLICY_V2",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "updatePolicyIntentV2": {
            "policyId": "<string>",
            "policyName": "<string>",
            "policyEffect": "<EFFECT_ALLOW>",
            "policyCondition": "<string>",
            "policyConsensus": "<string>",
            "policyNotes": "<string>"
          }
        },
        "result": {
          "updatePolicyResultV2": {
            "policyId": "<string>"
          }
        }
      }
    }
  }
}