API V3Document
Updates the Document resource.
Update a previously uploaded document. Use this endpoint to correct the display name of a document or to change whether it is visible to the debtor in MijnDossier.
All fields are optional; only the fields present in the request are changed.
- The file_name must end with .pdf.
- The description field represents the subject of the document and is the display name in MijnDossier.
- The visible_for_debtor field controls whether the file is visible in MijnDossier. This setting must also be enabled if the attachment is referenced in an email.
PATCH
/v3/documents/{id}curl -X PATCH "/v3/documents/{id}" \
-H "Authorization: Bearer $POM_API_DOCUMENTATION_API_KEY" \
-H "Content-Type: application/merge-patch+json" \
-d '{
"file_name": "1234567890.pdf",
"description": "Factuur",
"visible_for_debtor": true
}'Authorization
AuthorizationstringheaderrequiredOAuth 2.0 client credentials Grant
Parameters
idstringpathrequiredDocument identifier
Body
application/merge-patch+json
The updated Document resource
file_namestring | nulldescriptionstring | nullvisible_for_debtorboolean | null
Response
application/json
Document resource updated
object
{}