FYfynk
Document Operations

Rename attachment

Changed on

<small>Requires an API token with the Document Manager role.</small>

Changes the file name of an attachment of the given document.

Attachments can only be renamed while the document's content can still be changed. A 409 response is returned if, for example, the document is archived, approved, in signing or bound by a preemptive signature.

put/documents/{document}/attachments/{attachment}

Request

  • Base URL
    https://app.fynk.com/v1/api
  • URL
    https://app.fynk.com/v1/api/documents/{document}/attachments/{attachment}
  • Auth
    HTTP bearer

Path parameters

documentstring required

The document UUID

attachmentstring required

The attachment UUID

Request body

file_namestring required

The new name of the attachment

Example request

{
  "file_name": "Appendix_A.pdf"
}

Response

AttachmentMinimalResource

Example response

{
  "data": {
    "uuid": "c3f8ca57-b1a4-4560-b3fe-5f3fffb333dd",
    "sha256": "697651f6ceea8a931289ff64cb62f78ceea5d36f7e84590fe9d5920b2dce52cf",
    "file_name": "Appendix_A.pdf",
    "file_size": 544600,
    "mime_type": "application/pdf"
  }
}

Changes