Skip to main content

Update document

PATCH 
/documents/:id

Update an Existing Document.

This endpoint allows the authenticated user to update the details of an existing document associated with a specific applicant. The document ID must be provided to identify which document to update.

Authentication:​

  • Requires a valid OAuth access token with the following scopes:
    • document:write
    • Or one of the internal scopes: org:staff, org:admin, admin
    • Public scopes may also be included.

Parameters:​

  • id (required, path): The unique identifier (UUID) of the document to be updated.

Response:​

  • 200 OK: Returns the updated details of the document, confirming the changes.
  • 404 Not Found: If the document with the provided ID cannot be found.
  • 403 Forbidden: If the user does not have the necessary permissions to update the document.

Request​

Responses​

Successful Response