Skip to main content
POST
Call connections.request_number_purchase

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
phone_number
string

The exact number the operator chose, in full international format: never one you composed, and never a number the operator merely mentioned in passing. Required when the workspace texts through HighLevel; for Goosy's own texting, leave it out to take the first available number of number_type.

number_type
enum<string>
default:toll_free

For Goosy's own texting: toll_free (approved in about 3 to 5 business days) or local (a local number, approved in about 2 to 3 weeks). Ignored when the workspace texts through HighLevel.

Available options:
toll_free,
local
area_code
string

Three digits, for a local number in one area. Leave it out for any area.

Pattern: ^[2-9][0-9]{2}$
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.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
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
state
required
Allowed value: "confirmation_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.

confirmation_id
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
expires_in_seconds
integer
request_summary
string

What will happen, in one sentence, for a person to approve before confirming.

phone_number
string
sends_through
enum<string>

ghl: bought in the workspace's HighLevel account. twilio: Goosy's own texting.

Available options:
ghl,
twilio
sender_id
string | null

The new number's sender id; null for a HighLevel number.