Gallery Platform API
Reference

Update a contact document

Updates a document's editable fields (kind, title). Requires a first-party session.

PATCH
/gallery/contacts/{id}/documents/{documentId}

Updates a document's editable fields (kind, title). Requires a first-party session.

Authorization

bearerAuth contacts:update
AuthorizationBearer <token>

A gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).

In: header

Scope: contacts:update

Path Parameters

id*string

The contact id.

documentId*string

The document id.

Header Parameters

Idempotency-Key?string

Optional. Send a unique key per logical operation to make retries safe: a retry with the same key replays the stored success for 14 days instead of re-running the write. Reusing a key with a different body returns 400.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Update a contact document's editable fields.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "id": "string",  "contact_id": "string",  "storage_path": "string",  "url": "string",  "kind": "agreement",  "title": "string",  "file_name": "string",  "content_type": "string",  "byte_size": -9007199254740991,  "position": -9007199254740991,  "created_at": "string",  "updated_at": "string"}