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

# Call links.domain_set

`POST /api/v1/tools/links.domain_set`

## Request

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

Move this brand's tracked links onto a domain the customer owns — 'use our own domain for tracked links', 'check if our link domain is set up yet'. Put this brand's tracked links on a domain the customer owns — for the whole account or for one brand — and check on one that is still being set up. Pass the ROOT domain they own (northwindcoffee.com); the links. prefix is added for them. If we hold the domain we add the record ourselves and it is live in about a minute; otherwise the answer carries the one record they add wherever their domain lives, and `action: "check"` with the returned id looks for it. Links already out there keep working either way. Not for connecting a domain to a site — that is `domain.connect`.

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
  - `action` 'set' | 'check', required: `set` puts the links on a domain they own; `check` looks again for a record they were asked to add.
  - `root_domain` string: The domain they own, e.g. northwindcoffee.com. Required for `set`. Do not add a prefix — that is added for them.
  - `level` 'tenant' | 'workspace': `workspace` (the default) sets it for THIS brand; `tenant` sets it for the whole account, covering every brand that has none of its own.
  - `link_domain_id` string: Required for `check` — the id the `set` call returned.
  - `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
    - `link_domain_id` string, required
    - `hostname` string, required
    - `state` string, required
    - `live` boolean, required
    - `we_set_the_record` boolean, required
    - `record` object, nullable, required
      - `type` string, required
      - `name` string, required
      - `points_to` string, required
    - `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)