Update a party
Updates a party's base fields and its sub-profiles. For a member, edits accumulate in the working draft until the next save; for an API key or an installed app, they land on the record. Pass `draft` to choose; `applied_to` in the response says where the write went.
Updates a party's base fields and its sub-profiles. For a member, edits accumulate in the working draft until the next save; for an API key or an installed app, they land on the record. Pass draft to choose; applied_to in the response says where the write went.
Authorization
bearerAuth contacts:update, gallery:readA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: contacts:update, gallery:read
Path Parameters
The party id.
Query Parameters
Where the write lands. true: the working draft (a member's default). false: the record itself, reconciling any pending draft (a key's default). Omit for the principal's default.
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
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 party.
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", "applied_to": "draft"}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}Merge a party POST
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.
Get a payable GET
Returns one consignor payable: the owed amount and currency, the payee, the sale and line it arose from, the frozen basis, and its settlement status.