Document

Update the document

patch/documents/{document_id}

Request

  • Base URL: https://api-docs.simplepdf.com/api/v1
  • URL: https://api-docs.simplepdf.com/api/v1/documents/{document_id}
  • Auth: HTTP bearer

Path parameters

document_idstring uuid required

Request body

namestring

Example request

{
  "name": "Updated Document.pdf"
}

Response

Successful response

idstring required
namestring required
embed_urlstring required

Public link a recipient opens to fill and submit the document in the SimplePDF editor, standalone or embedded in an iframe. No expiry; anyone with the link can use it. Append ?prefill=<prefill_id> to apply a prefill.

created_atstring required
updated_atstring required
urlstring required

Short-lived presigned URL to download the original document PDF (the uploaded file, not a submission). Expires shortly after issue; fetch a fresh one per use.

Example response

{
  "id": "05666d45-96d0-42ce-b24b-f1f1af228f57",
  "name": "Document.pdf",
  "embed_url": "https://api-docs.simplepdf.com/documents/05666d45-96d0-42ce-b24b-f1f1af228f57",
  "created_at": "2025-03-09T21:35:10.599Z",
  "updated_at": "2025-04-20T13:40:46.594Z",
  "url": "https://presigned-url-to-download-the-document"
}

Changes

No recorded changes to this operation across all 1 revision of this API.