Delete Policy

Delete an existing Policy

POST

/

public

/

v1

/

submit

/

delete_policy

Authorizations

API Key

X-Stamp

string

header

required

Webauthn (Passkey)

X-Stamp-Webauthn

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_DELETE_POLICY

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.

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.deletePolicyIntent

object

required

The deletePolicyIntent object

Show deletePolicyIntent details

activity.intent.deletePolicyIntent.policyId

string

required

Unique identifier for a given Policy.

activity.result

object

required

The result of the activity

Show result details

activity.result.deletePolicyResult

object

required

The deletePolicyResult object

Show deletePolicyResult details

activity.result.deletePolicyResult.policyId

string

required

Unique identifier for a given Policy.

cURL

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

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_DELETE_POLICY",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "deletePolicyIntent": {
            "policyId": "<string>"
          }
        },
        "result": {
          "deletePolicyResult": {
            "policyId": "<string>"
          }
        }
      }
    }
  }
}