Sign in
Order Internal Documents

Update internal document metadata and/or replace the file

Update title and/or notes. Optionally send a single "file" to replace the stored document. Omit title/notes to leave them unchanged; empty string clears to null.

patch/orders/{orderId}/internal-documents/{documentId}

Path parameters

orderIdnumber required
documentIdnumber required

Request body

titlestring nullable
notesstring nullable
filestring binary

Optional replacement file

Response

Internal document updated successfully

idnumber required
orderIdnumber required
fileNamestring required
originalFileNamestring required
filePathstring required
mimeTypestring
fileSizenumber
uploadedBynumber required
titlestring
notesstring
createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "id": 1,
  "orderId": 1302,
  "fileName": "ef9b2a52-06cb-44ac-87ec-a619d10f24a1.pdf",
  "originalFileName": "search-result.pdf",
  "filePath": "https://s3.eu-west-1.amazonaws.com/example-bucket/uploads/internal-documents/ef9b2a52-06cb-44ac-87ec-a619d10f24a1.pdf",
  "mimeType": "application/pdf",
  "fileSize": 125845,
  "uploadedBy": 8,
  "uploadedByUser": {
    "id": 8,
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com"
  },
  "title": "Registry extract",
  "notes": "Re-check signatures before sharing with ops."
}

Changes

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