Update Document Metadata

PATCH

https://api.captain.dev/v3/collections/:collection_name/documents/:document_id/metadata

PATCH

/v3/collections/:collection_name/documents/:document_id/metadata

1 import json
2 import requests
3 import uuid
4 
5 BASE_URL = "https://api.captain.dev"
6 API_KEY = "your_api_key"
7 COLLECTION_NAME = "my_documents"
8 DOCUMENT_ID = "b3f9a1c2d4e5f60718293a4b5c6d7e8f"
9 
10 headers = {
11     "Authorization": f"Bearer {API_KEY}",
12     "Content-Type": "application/json",
13     "Idempotency-Key": str(uuid.uuid4()),
14 }
15 
16 response = requests.patch(
17     f"{BASE_URL}/v3/collections/{COLLECTION_NAME}/documents/{DOCUMENT_ID}/metadata",
18     headers=headers,
19     json={
20     "custom_metadata": {
21         "reviewed": "yes",
22         "draft_flag": null
23     }
24 },
25     timeout=30.0
26 )
27 
28 print(json.dumps(response.json(), indent=2))

200Updated

1 {
2   "document_id": "b3f9a1c2d4e5f60718293a4b5c6d7e8f",
3   "custom_metadata": {
4     "external_id": "doc_18842",
5     "client": "acme-lending",
6     "reviewed": "yes"
7   },
8   "filterable": true,
9   "updated_at": null
10 }

Merge keys into a document’s custom_metadata without restating the whole object; a null value deletes its key. Use PUT instead to replace the stored object wholesale.

Path parameters

collection_namestringRequired

document_idstringRequired

Request

This endpoint expects an object.

metadataobjectOptional

Response

Update Document Metadata response.

document_idstring

custom_metadatamap from strings to anyOptional

filterablebooleanOptionalDefaults to false

updated_atstring or nullOptional