Document AI — DMS

Update document type

Update a custom document type (is_system_default = 0 only). Requires id or type_key.

post/documents/document-types-update

Request

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

Request body

idinteger

Document type numeric id from po_documents_document_types_list

type_keystring

Document type key (Alternative to id)

name_defaultstring

New display name for custom document types

retention_yearsinteger

Updated retention period in years.

retention_mode'none' | 'compliance'

Updated retention policy: none or compliance.

description_defaultstring

Updated default description for the custom document type.

descriptionstring

Alias for description_default (accepted for MCP/Postman compatibility).

Response

Success

status'success' required
_billingobject

Changes

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