Update an approval policy

Platform module

PATCH/approval-policies/{id}approvalPolicies.update

An approval policy with ordered steps. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Requires the capability org.approval_policies.write.
OAuth scopes: org.
Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

approvalPolicies.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the approval policy.

Request body: ApprovalPolicyUpdate

approvalPolicies.update: ApprovalPolicyUpdate
Field	Type	Required	Description
name	string	No	Policy name.Constraints: length 1 to 300
description	string \| null	No	What the policy is for.Constraints: length 1 to 20000
currency_code	string \| null	No	ISO 4217 currency of applies_above_minor; null for every amount.Constraints: pattern ^[A-Z]{3}$
applies_above_minor	integer (int64) \| null	No	The policy applies above this amount in currency_code, and to every amount in another currency; null for every document of the type. Integer minor units of the resource currency; null means unpriced, never zero.

{
  "name": "PO Over Limit",
  "description": "Every purchase order goes to finance.",
  "currency_code": "USD",
  "applies_above_minor": 1000000
}

Response 200: ApprovalPolicy

approvalPolicies.update: ApprovalPolicy
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the approval policy.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
name	string	Yes	Policy name.Constraints: length 1 to 300
document_type	"Purchase Order" \| "Change Order" \| "Expense" \| "Invoice Approval" \| "Payroll Run" \| "Requisition"	Yes	Spend document type the policy gates.
description	string \| null	Yes	What the policy is for.Constraints: length 1 to 20000
currency_code	string \| null	Yes	ISO 4217 currency of applies_above_minor; null for every amount.Constraints: pattern ^[A-Z]{3}$
applies_above_minor	integer (int64) \| null	Yes	The policy applies above this amount in currency_code, and to every amount in another currency; null for every document of the type. Integer minor units of the resource currency; null means unpriced, never zero.
policy_state	"Draft" \| "Active" \| "Retired"	Yes	Policy state.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "PO Over Limit",
  "document_type": "Purchase Order",
  "description": "Every purchase order goes to finance.",
  "currency_code": "USD",
  "applies_above_minor": 1000000,
  "policy_state": "Active"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/approval-policies/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"name":"PO Over Limit","description":"Every purchase order goes to finance.","currency_code":"USD","applies_above_minor":1000000}'

const { data, etag } = await xos.approvalPolicies.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "name": "PO Over Limit",
    "description": "Every purchase order goes to finance.",
    "currency_code": "USD",
    "applies_above_minor": 1000000
  }, { ifMatch: etag });

response = xos.approval_policies.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "PO Over Limit", "description": "Every purchase order goes to finance.", "currency_code": "USD", "applies_above_minor": 1000000}, if_match=etag)

xos approval-policies update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"PO Over Limit","description":"Every purchase order goes to finance.","currency_code":"USD","applies_above_minor":1000000}' --if-match auto