Update an existing policy. Updating a policy creates a new version — the previous version is preserved for audit history. The logicalId remains the same across versions.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string (UUID) | Yes | Policy UUID to update |
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Updated policy name |
description | string | No | Updated description |
type | string | No | Updated action type |
status | string | No | DRAFT, PENDING_APPROVAL, ACTIVE, INACTIVE, or ARCHIVED |
enforcementMode | string | No | STRICT or AUDIT_ONLY |
conditionLogic | string | No | ALL or ANY |
policyGroupId | string (UUID) | No | Policy group to associate (nullable) |
conditions | array | No | Replacement array of conditions |
actions | array | No | Replacement array of actions |
Note: Updates to ACTIVE policies may require approval depending on your organization's settings.
policies:edit
Update an existing policy. Updating a policy creates a new version — the previous version is preserved for audit history. The logicalId remains the same across versions.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string (UUID) | Yes | Policy UUID to update |
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Updated policy name |
description | string | No | Updated description |
type | string | No | Updated action type |
status | string | No | DRAFT, PENDING_APPROVAL, ACTIVE, INACTIVE, or ARCHIVED |
enforcementMode | string | No | STRICT or AUDIT_ONLY |
conditionLogic | string | No | ALL or ANY |
policyGroupId | string (UUID) | No | Policy group to associate (nullable) |
conditions | array | No | Replacement array of conditions |
actions | array | No | Replacement array of actions |
Note: Updates to ACTIVE policies may require approval depending on your organization's settings.
policies:edit