Skip to content

Update Acknowledgment Instance

Update an acknowledgment assigned to the authenticated user. The document acknowledgments feature must be enabled for the target.

Parameters

name * are required parametersdata typedescription
instanceId*stringThe unique identifier of the acknowledgment instance
body.state*stringThe new state: inprogress or completed
body.recordVersionnumberRequired when completing; must be a positive integer

Return Value

The updated acknowledgment instance.

Error Codes

  • 400 Bad Request: The state or record version is invalid.
  • 404 Not Found: The acknowledgment instance does not exist.
  • 409 Conflict: The acknowledgment cannot transition to the requested state.

Examples

bash
curl -X PUT "https://app.wombat.software/api/{targetPath}/acknowledgment/:instanceId" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ..." \
  -d '{"state":"completed","recordVersion":3}'

ENDPOINTS

put/api/{targetPath}/acknowledgment/:instanceId