API Reference
Bulk acknowledge policy changes
Acknowledge multiple policy changes at once. Accepts up to 200 diff IDs. Uses ON CONFLICT DO NOTHING for idempotency.
Requires Professional plan or higher and an API key with write or admin scope.
Authorization
bearerAuth AuthorizationBearer <token>
API keys are prefixed with bwk_live_ for production or bwk_test_ for testing.
Example: bwk_live_abc123xyz
Keys issued before the current format carry the vrt_live_/vrt_test_ prefix. Both prefixes are accepted while integrations rotate.
In: header
Request Body
application/json
diff_ids*array<>
Array of policy diff IDs to acknowledge
Items
1 <= items <= 200notes?string
Length
length <= 500Response Body
application/json
application/json
curl -X POST "https://backworkhealth.com/api/v1/compliance/ack/bulk" \ -H "Content-Type: application/json" \ -d '{ "diff_ids": [ 0 ] }'{
"success": true,
"data": {
"acknowledged": 0,
"already_acked": 0,
"total": 0
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid query parameters",
"hint": "Check the 'code' parameter format",
"details": {}
},
"meta": {
"request_id": "req_abc123"
}
}Last updated on