Create Document Acknowledgments

Requires ADMIN or MANAGE_DOCUMENTS permission and the document acknowledgments feature for the target.

Creates acknowledgments for each selected published document and active recipient. Roles resolve to their current active users; overlapping selections are deduplicated. This does not change role requirements or assign future role members.

Existing pending requests and completed acknowledgments that cover the document's latest published version are skipped. A newer published version can be requested even when acknowledgmentVersion has not advanced, is absent, or is ahead of the published version. New instances leave recordVersion unset until completion. Requests follow the normal role-requirement removal rules. Creation uses the normal acknowledgment notification flow.

Parameters

Required body field	Type	Description
documentIds	string[]	Between 1 and 200 published document IDs. Folders, drafts without a published version, archived documents, and missing documents are rejected.
userIds	string[]	Up to 200 user IDs in this target; may be empty when roles are selected. Inactive and removed users are skipped.
roleIds	string[]	Up to 200 role IDs in this target; may be empty when people are selected.

At least one person or role must be selected. Role expansion may include more than 200 recipients.

Response

{
  "statusCode": 200,
  "data": { "created": 4, "skipped": 2, "users": 3 },
  "message": "Document acknowledgments processed"
}

users counts unique recipients after role expansion. skipped counts document-recipient pairs that did not create a new acknowledgment.

Malformed input and unavailable documents, people, or roles return 400 before creation begins. Writes are committed in batches per user, with documents grouped using the batch binning utility. A later failure can leave earlier batches completed; sequential retries skip existing requests. Simultaneous requests can create duplicate acknowledgments because reads and writes are not transactional.