PlatformDocs
MCP server

add_outreach_domain

Add an available domain to a website's picked list (the purchase cart).

View as Markdown

Pick outreach domain · Changes data

Add an available domain to a website's picked list (the purchase cart). Nothing is bought or charged: purchase_outreach_domains later buys every picked domain at once. Call search_domain_availability first; the server uses its own quote from that search (re-checked if older than 6 hours) and refuses a domain that is not available. Remove a pick with remove_outreach_domain; see the cart with list_outreach_domains. websiteId comes from list_websites. Returns success and outreachDomains[] (the current unpaid picks), with alreadyAdded: true when the domain was already picked. Not available with a website-scoped key.

ConnectionAccount-owner URL or OAuth (not a team member URL)

Parameters

ParameterTypeRequiredAcceptsDescription
websiteIdstringYesanyWebsite id from list_websites to attach the domain to.
domainstringYesanyDomain name to pick, e.g. getacme.example.
replacePickedbooleanNoanytrue to drop the other unpaid picks and keep only this domain. Default false, which adds to the list.

Tool definition

What your assistant receives from tools/list:

{
  "name": "add_outreach_domain",
  "title": "Pick outreach domain",
  "annotations": {
    "title": "Pick outreach domain",
    "readOnlyHint": false,
    "destructiveHint": false,
    "idempotentHint": true,
    "openWorldHint": false
  },
  "inputSchema": {
    "type": "object",
    "properties": {
      "websiteId": {
        "type": "string",
        "description": "Website id from list_websites to attach the domain to."
      },
      "domain": {
        "type": "string",
        "description": "Domain name to pick, e.g. getacme.example."
      },
      "replacePicked": {
        "type": "boolean",
        "description": "true to drop the other unpaid picks and keep only this domain. Default false, which adds to the list."
      }
    },
    "required": [
      "websiteId",
      "domain"
    ]
  }
}

On this page