Acknowledge a policy change

Endpoint: POST /api/v1/compliance/ack

Availability: Live in production.

Authentication: API key in Authorization: Bearer <key> with the write scope.

Mark a single policy change as reviewed for the authenticated organization. Idempotent: acknowledging an already-acknowledged change returns 200. Requires a plan with the compliance dashboard and an API key with write scope.

Parameters

• diff_id (body, required): The policy diff ID to acknowledge
• notes (body): Optional notes about the acknowledgment

Example request

curl -X POST "https://backworkhealth.com/api/v1/compliance/ack" \
  -H "Authorization: Bearer $BACKWORK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "diff_id": 0
}'

Example response (200)

{
  "success": true,
  "data": {
    "acknowledged": true,
    "already_acked": true
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2026-01-15T10:30:00Z"
  }
}

curl -X POST "https://example.com/compliance/ack" \  -H "Content-Type: application/json" \  -d '{    "diff_id": 1  }'

{  "success": true,  "data": {    "acknowledged": true,    "already_acked": true  },  "meta": {    "request_id": "string",    "timestamp": "2019-08-24T14:15:22Z"  }}

Last updated on