---
title: "PATCH /document/{tenantLocator}/documents/{locator}"
method: PATCH
path: "/document/{tenantLocator}/documents/{locator}"
---

# PATCH /document/{tenantLocator}/documents/{locator}

`PATCH /document/{tenantLocator}/documents/{locator}`

## Request

- Base URL: `https://docs.socotra.com`
- URL: `https://docs.socotra.com/document/{tenantLocator}/documents/{locator}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/document/:tenantLocator/documents/:locator/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tenantLocator` string, uuid, required
- `locator` string, ulid, required

## Query parameters

- `metadata` string
- `category` string

## Request body `multipart/form-data`

- object
  - `document` string, binary

## Response `200`

OK

- DocumentInstanceResponse
  - `locator` string, ulid, required
  - `referenceLocator` string, ulid, required
  - `referenceType` 'quote' | 'policy' | 'invoice' | 'transaction' | 'segment' | 'term' | 'quoteGroup', required
  - `referenceDocumentLocator` string, ulid
  - `transactionLocator` string, ulid
  - `segmentLocator` string, ulid
  - `termLocator` string, ulid
  - `policyLocator` string, ulid
  - `name` string
  - `staticName` string
  - `documentInstanceState` 'draft' | 'dataReady' | 'ready' | 'dataError' | 'renderError' | 'conversionError' | 'rendered' | 'removed', required
  - `documentFormat` 'csv' | 'doc' | 'docx' | 'html' | 'jpeg' | 'jpg' | 'pdf' | 'text' | 'txt' | 'xls' | 'xlsx' | 'zip', required
  - `metadata` object, required
  - `createdAt` string, date-time, required
  - `createdBy` string, uuid
  - `readyAt` string, date-time
  - `renderingData` object, required
  - `processingErrors` string
  - `external` boolean, required
  - `category` string
  - `consolidatedFrom` string[], required
  - `consolidatedTo` string[], required
  - `copyOnIssuance` boolean

---

[API](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi.md) - [All operations](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/revisions/77ee7d8172b9?raw)