---
title: "Call contact.link"
method: POST
path: "/api/v1/tools/contact.link"
tags: ["contact"]
---

# Call contact.link

`POST /api/v1/tools/contact.link`

## Request

- Base URL: `https://app.goosybear.ai`
- URL: `https://app.goosybear.ai/api/v1/tools/contact.link`
- Auth: HTTP bearer

Attach an email, phone number or handle you hold to the right customer — 'that's the same person as this lead', 'add this email to their record', 'this number belongs to them'.  Attach a key you hold from a conversation — an email, a phone number, a Messenger id — to a customer, or take one off again. Calling it shows the operator an approve card naming the change first, and nothing is written unless they approve it themselves. You cannot approve it for them, and never pass confirm_token. Keys are matched exactly, never on a likeness, and one that already belongs to somebody else is refused rather than moved. Not for looking a customer up — that is `contact.get`. Over the API it answers in two calls: without confirmation_id it proposes — says what would happen, returns a confirmation_id and changes, spends and sends nothing; the same arguments again with that confirmation_id, on a member's own API key, do it.

Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with `workspace_ambiguous` and lists the choices — offer them, never pick one.

## Headers

- `x-request-id` string

## Request body

- object
  - `contact_id` string, uuid, required: The customer this key belongs to. Read them with contact.get first — never a guess at who a key belongs to.
  - `identity_kind` 'email' | 'phone' | 'meta_psid' | 'ig_id' | 'ghl_contact_id' | 'gbp_reviewer', required: Which kind of key this is: an email address, a phone number, a Messenger id (meta_psid), an Instagram id (ig_id), a CRM record id (ghl_contact_id), or a Google reviewer id.
  - `identity_value` string, required: The key exactly as you observed it. It is normalised before it is looked up, so capitals in an address are fine — but a phone number without its country code cannot be matched and will be refused rather than guessed at.
  - `identity_scope` string: The Meta PAGE id the key was seen on. REQUIRED for meta_psid and ig_id — those ids are only unique within one page, so without it nothing can be matched. Leave it out for every other kind.
  - `action` 'link' | 'unlink', required: `link` attaches the key to that customer; `unlink` takes it off again. Both are recorded on their history.
  - `confirmation_id` string, uuid: Omit to propose: the first call says what would happen, returns a confirmation_id and changes nothing. To go ahead, send the same arguments again with that confirmation_id, on a member's own API key; a service account's key can propose but never confirm.
  - `workspace` string: Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

## Response `200`

The call was admitted and dispatched. `ok` says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

- union
  - object: The tool ran and answered.
    - `ok` true, required
    - `state` 'confirmation_required'
    - `confirmation_id` string, uuid
    - `expires_in_seconds` integer
    - `request_summary` string: What will happen, in one sentence, for a person to approve before confirming.
    - `outcome` 'proposed' | 'linked' | 'unlinked'
    - `contact_id` string
    - `display_name` string, nullable
    - `identity_kind` 'email' | 'phone' | 'meta_psid' | 'ig_id' | 'ghl_contact_id' | 'gbp_reviewer'
    - `identity_masked` string
    - `evidence` string
    - `waiting_on` string, nullable
    - `local_row_id` string, nullable
    - `workspace` string, required: The slug of the workspace this call ran in.
    - `working_in` object, required: Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.
      - `label` string, required: The chip words — e.g. "working in: Acme Main".
      - `note` string, required: Why this workspace — e.g. "your default", "this call only".
      - `workspace` string, required: The resolved workspace's slug.
      - `source` 'call-override' | 'key-pin' | 'stored-default' | 'sole-reachable', required: Which rung of the R7 precedence resolved the workspace.
  - ToolRefusal: A call that was admitted and dispatched, and did not succeed.
    - `ok` false, required
    - `code` string, required: The typed reason — e.g. `workspace_ambiguous`, `invalid_arguments`, or the tool's own failure code.
    - `message` string, required: A sentence a person can act on.
    - `workspaces` string[]: On a workspace refusal: the slugs this key may pass as `workspace`.
    - `issues` object[]: On `invalid_arguments`: which fields failed, and why.
      - `path` string, required
      - `message` string, required
    - `path` string: On an authoring refusal: where in your call's input it points, e.g. `steps.<key>.params.<field>`.
    - `fix` string: On an authoring refusal: the change to your call that would pass.
    - `instruction` string: On an authoring refusal: what to do next with it.

## Other responses

- `400`: The request could not be used: the body is present but not a JSON object (`tenant_api.malformed_body`); it is a top-level array carrying more messages than this endpoint accepts (`tenant_mcp.batch_too_large`); or the `Idempotency-Key` header is malformed (`tenant_api.idempotency_key_invalid`), disagrees with the body's `idempotency_key` (`tenant_api.idempotency_key_conflict`), or was sent to an action that cannot replay a retry (`tenant_api.idempotency_unsupported`). Nothing ran.
- `401`: No bearer credential, or one that did not resolve. Deliberately ONE undifferentiated answer for absent / unknown / revoked / expired, so the endpoint is never an oracle over the key space.
- `403`: The credential is good but the surface is not open to it — the platform or account API switch is off, or the holder lacks the `api.access` capability. The `code` says which.
- `404`: No such tool. The body names no tool and is identical for every unrecognised name.
- `429`: Over this key's per-minute cap. Carries `Retry-After` and `error.retry_after_seconds`.

---

[API](https://skmtc.dev/goosybear/apis/goosy-bear-api.md) · [All operations](https://skmtc.dev/goosybear/apis/goosy-bear-api/llms.txt) · [OpenAPI document](https://skmtc.dev/goosybear/apis/goosy-bear-api/revisions/6d82fb124064?raw)