links

Call links.domain_set

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.

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

Headers

x-request-idstring

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Request body

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_domainstring

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_idstring

Required for check — the id the set call returned.

workspacestring

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

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.

OR

Changes

No recorded changes to this operation across all 4 revisions of this API.