Skip to main content
POST
Call links.domain_set

Authorizations

Authorization
string
header
required

An API key minted at Settings › API & MCP. Send it as Authorization: Bearer <key>. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (GOOSY_API_KEY), never in a committed file.

Headers

x-request-id
string

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.

Maximum string length: 128

Body

application/json
action
enum<string>
required

set puts the links on a domain they own; check looks again for a record they were asked to add.

Available options:
set,
check
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
enum<string>

workspace (the default) sets it for THIS brand; tenant sets it for the whole account, covering every brand that has none of its own.

Available options:
tenant,
workspace

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.

Minimum string length: 1

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.

The tool ran and answered.

ok
boolean
required
hostname
string
required
state
string
required
live
boolean
required
we_set_the_record
boolean
required
record
object | null
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.