Skip to main content
POST
Call connections.request_ad_account_access

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
platform
enum<string>
required

Which advertising platform's ad account to set up on that platform's own account — the customer owns the account and grants us access to it. The allowed values are the enum's; do not offer a platform outside it.

Available options:
meta,
google,
tiktok,
linkedin
external_account_id
string
required

The operator's OWN ad account id, exactly as the platform writes it (Meta: act_1234567890). This names WHICH account we ask about — it is an account identifier and grants nothing by itself. NEVER pass a password, token or API key here.

Minimum string length: 1
external_business_id
string | null

Their business portfolio / Business Center id, where the platform has one. Omit unless the operator gave you one.

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.

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
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.

state
string
Allowed value: "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.

platform
enum<string>
Available options:
meta,
google,
tiktok,
linkedin
grant_state
enum<string>
Available options:
not_started,
awaiting_customer_creation,
awaiting_authorization,
awaiting_platform_access,
request_issued,
awaiting_customer_accept,
active,
revoked,
failed
status_sentence
string | null
external_account_id
string | null
next_step_key
string | null
next_step_title
string | null
steps
object[]