Bulk Update Role Acknowledgments

Update document acknowledgment requirements and document visibility for up to 200 roles. Requires ADMIN or MANAGE_DOCUMENTS permissions, and the document acknowledgments feature must be enabled for the target.

Use an acknowledgment requirement to add a document to a role or null to remove it. The key in acknowledgments must match the requirement's recordId.

Parameters

name * are required parameters	data type	description
body.roles*	object[]	Between 1 and 200 role updates
body.roles[].id*	string	The role identifier
body.roles[].acknowledgments*	object	Document IDs mapped to acknowledgment requirements or null
body.roles[].hidden	object	Document IDs mapped to whether they are hidden from the role

Return Value

{
  "statusCode": 200,
  "data": true,
  "message": "Bulk role acknowledgments updated"
}

Error Codes

• 400 Bad Request: The request is malformed, contains duplicate roles, or has more than 200 roles.
• 404 Not Found: A role or document does not exist.
• 409 Conflict: A role has been removed or is controlled externally.

Examples

bash

curl -X POST "https://app.wombat.software/api/{targetPath}/bulk-role-acknowledgment-update" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ..." \
  -d '{"roles":[{"id":"role-id","acknowledgments":{"document-id":{"type":"acknowledgment","recordId":"document-id"}},"hidden":{"document-id":false}}]}'