Relations

Preview a relation edit

POST/relations/preview

Scopegraph:readRoleCurrent memberBilling1 credit per call

Takes the same body as POST /relations and returns what would be retired, added, revived or confirmed, the current edges with their sourceClass, and the modes that make sense right now. No write.

Body

application/json

fromKindenumrequired

customer · account_person

fromIduuidrequired

relationTypeenumrequired

toKindenumrequired

icp · persona · use_case · product · competitor

toIduuidoptional

Required for add and replace.

modeenumrequired

add · replace · retire

reasonstringrequired

Why this change is being made. 1–500 characters. Stored in the audit trail.

Response

200 · application/json

current(Relation & { sourceClass })[]

wouldRetireRelation[]

wouldAdd{ toKind, toId } | null

wouldReviveRelation | null

wouldConfirmRelation | null

options{ mode, description }[]

curl --fail-with-body "https://app.ghostgtm.ai/api/v1/relations/preview" \ -H "Authorization: Bearer $GHOST_API_KEY" \ -H "Content-Type: application/json" \ --data '{ "fromKind": "customer", "fromId": "6b1e9a44-2c7d-4f0a-9e3b-1d5c8a7f2e90", "relationType": "matches_icp", "toKind": "icp", "toId": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f", "mode": "replace", "replace": { "scope": "all_llm" }, "reason": "Rep confirmed the ICP on the call" }'

{ "current": [ { "id": "9b8c…", "to_entity_id": "5e6f…", "relation_type": "matches_icp", "source": "llm:pmm-label-refresh", "sourceClass": "llm" } ], "wouldRetire": [ { "id": "9b8c…", "source": "llm:pmm-label-refresh" } ], "wouldAdd": { "toKind": "icp", "toId": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f" }, "wouldRevive": null, "wouldConfirm": null, "options": [ { "mode": "add", "description": "Add another relation alongside the current live ones." }, { "mode": "replace", "description": "Replace the selected current relation(s) with a new one." }, { "mode": "retire", "description": "Retire a current relation without adding a replacement." } ] }