Document AI — DMS

Rename document

Rename a document. The original extension is always preserved. Path separators (/, , .) are rejected. Special characters are removed, leading dots are deleted. Maximum length: 255 characters.

post/documents/document-rename

Request

  • Base URL: https://api.paperoffice.ai/latest
  • URL: https://api.paperoffice.ai/latest/documents/document-rename
  • Auth: HTTP bearer

Response

Success

status'success' | 'error'

Request status (ok/error)

messagestring

Status message

pofidstring

PaperOffice File ID

new_namestring

New name

processing_timestring

Request processing time (e.g. "123.45ms")

documentstring

Document

old_file_namestring

Old file name

new_file_namestring

New file name

workspace_idstring

Workspace id

Changes

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