Gallery Platform API
Reference

Merge a party

Merges the party `merged_id` into this one, moving everything that points at it (interactions, tasks, notes, pipeline entries, ownership, roles, accounts, and the rest), then deleting it. The merged id keeps reading as this party. Refused with 409 when both parties belong to gallery members, both have a collector account, both have a Stripe customer, or either is the gallery's own party. Confirmation-gated: pass `confirm: true`. Cannot be undone.

POST
/gallery/parties/{id}/merge

Merges the party merged_id into this one, moving everything that points at it (interactions, tasks, notes, pipeline entries, ownership, roles, accounts, and the rest), then deleting it. The merged id keeps reading as this party. Refused with 409 when both parties belong to gallery members, both have a collector account, both have a Stripe customer, or either is the gallery's own party. Confirmation-gated: pass confirm: true. Cannot be undone.

Authorization

bearerAuth contacts:delete, contacts:update, gallery:read
AuthorizationBearer <token>

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

In: header

Scope: contacts:delete, contacts:update, gallery:read

Path Parameters

id*string

The party id.

Query Parameters

dry_run?boolean

Preview this operation without committing it. When true, the request is authenticated, scoped, and validated, but no side effect runs — no write, no idempotency claim, no audit event, no outbound delivery. The response is HTTP 200 with an X-Dry-Run: true header and a body of { "dry_run": true }, plus an effect object describing what the real call would change when this operation can resolve one.

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.

Merge the party merged_id into this one (confirmation-gated).

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "id": "string",  "name": "string",  "kind": "person",  "contact_type": "collector",  "company": "string",  "city": "string",  "email": "string",  "phone": "string",  "notes": "string",  "lead_status": "new",  "form_of_address": "string",  "locale": "string",  "do_not_email": true,  "do_not_sms": true,  "acquisition_source": "inquiry",  "acquired_at": "string",  "archived_at": "string",  "ulan": "string",  "wikidata": "string",  "isni": "string",  "viaf": "string",  "lei": "string",  "assignee_ids": [    "string"  ],  "collector_profile": {    "collecting_focus": "string",    "budget_band": "string",    "wishlist_notes": "string",    "preferred_contact_method": "string",    "vip": true,    "tax_exempt": true,    "created_at": "string",    "updated_at": "string"  },  "institution_profile": {    "institution_kind": "string",    "tax_exempt": true,    "acquisition_process": "string",    "primary_contact_name": "string",    "created_at": "string",    "updated_at": "string"  },  "last_interaction_at": "string",  "last_interaction_type": "note",  "roles": [    {      "role": "collector",      "valid_from": "string"    }  ],  "custom_fields": {    "property1": null,    "property2": null  },  "save_state": "new",  "metadata": {    "property1": "string",    "property2": "string"  },  "created_at": "string",  "updated_at": "string"}