---
title: "Update document type"
method: POST
path: "/documents/document-types-update"
tags: ["Document AI — DMS"]
---

# Update document type

`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

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

## Request body

- object
  - `id` integer: Document type numeric id from po_documents_document_types_list
  - `type_key` string: Document type key (Alternative to id)
  - `name_default` string: New display name for custom document types
  - `retention_years` integer: Updated retention period in years.
  - `retention_mode` 'none' | 'compliance': Updated retention policy: none or compliance.
  - `description_default` string: Updated default description for the custom document type.
  - `description` string: Alias for description_default (accepted for MCP/Postman compatibility).

## Response `200`

Success

- SuccessEnvelope: Success envelope. Payload fields are endpoint-specific (top-level fields, `result`/`job_result` for jobs, `data` on some account endpoints).
  - `status` 'success', required
  - `processing_time` union
    - string
    - number
  - `_billing` object

## Other responses

- `4XX`: Error
- `5XX`: Error

---

[API](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api.md) · [All operations](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/revisions/c6a6228a4509?raw)