Backwork
API Reference

Bulk acknowledge policy changes

Acknowledge up to 200 policy changes at once.

Endpoint: POST /api/v1/compliance/ack/bulk

Availability: Live in production.

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

Acknowledge up to 200 policy changes at once. Changes that are already acknowledged are counted, not duplicated. Returns 400 when none of the IDs exist. Requires a plan with the compliance dashboard and an API key with write scope.

Parameters

  • diff_ids (body, required): Policy diff IDs to acknowledge; IDs that do not exist are counted in invalid_ids
  • notes (body)

Example request

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

Example response (201)

{
  "success": true,
  "data": {
    "acknowledged": 0,
    "already_acked": 0,
    "invalid_ids": 0,
    "total": 0
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2026-01-15T10:30:00Z"
  }
}
POST
/compliance/ack/bulk

Authorization

bearerAuth
AuthorizationBearer <token>

API key in format: bwk_live_xxxxx. Keys issued before the rename (vrt_live_) remain valid. bwk_test_ keys work only on the sandbox.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/compliance/ack/bulk" \  -H "Content-Type: application/json" \  -d '{    "diff_ids": [      1    ]  }'
{  "success": true,  "data": {    "acknowledged": 0,    "already_acked": 0,    "invalid_ids": 0,    "total": 0  },  "meta": {    "request_id": "string",    "timestamp": "2019-08-24T14:15:22Z"  }}

Last updated on