DocumentationConnect an AI agent

Agents & API

Connect Claude, ChatGPT, or Cursor

By the end of this page, your AI agent can use InboxJoy through its remote MCP server.

Connect your AI agent

InboxJoy is a remote MCP server. You do not need to build a separate integration.

  1. Add the connector URL

    Open your agent’s connector or MCP server settings and paste this URL:

    https://inboxjoy.online/mcp
  2. Sign in to InboxJoy

    Follow the redirect to InboxJoy. Sign in and choose the workspace the agent can access.

  3. Approve the requested permissions

    Review the exact permissions before you approve them. No API key is involved. The connection stays authorized until you revoke it in Settings → MCP → Connected apps.

Review the requested scopes

Every connection requests one or both scopes. InboxJoy shows each scope by name when you approve access.

ScopeWhat it allows
inboxjoy:readRead your campaigns and sending data.
inboxjoy:writeCreate campaigns and send on your behalf.

Use InboxJoy MCP tools

InboxJoy exposes every operation as an MCP tool named inboxjoy_<area>_<action>. Your agent can use about 57 tools.

ToolWhat it does
inboxjoy_leads_importImports up to 1,000 leads at once, optionally into a named list, with optional custom fields and per-campaign variables.
inboxjoy_campaigns_setLeadVariablesWrites personalized text for each lead, such as {{icebreaker}}, for one campaign.
inboxjoy_campaigns_getLeadVariablesShows which custom variables a campaign uses, how many leads are ready for each, and which leads still need values.
inboxjoy_campaigns_listLeadVariableNamesLists the custom variable names already used in your workspace.
inboxjoy_sequences_draftDrafts a multi-step sequence from a description.
inboxjoy_campaigns_createCreates a draft campaign from a sequence, list, and mailbox.
inboxjoy_campaigns_launchPublishes a campaign and enrolls every eligible contact.
inboxjoy_campaigns_getGets per-step analytics and enrollment status counts.
inboxjoy_analytics_summaryGets workspace delivery analytics and daily time series.
inboxjoy_export_csvExports leads, suppressions, or campaign results as CSV.

The full set covers leads, campaigns and sequences, sending analytics, suppressions, templates, search, notifications, and workspace and team read access. Read-scoped tools are available with inboxjoy:read alone. Write actions require inboxjoy:write.

Personalize each lead with custom variables

Sequence steps can use tokens such as {{icebreaker}} that carry a different line for every lead. Your agent writes the lines with inboxjoy_campaigns_setLeadVariables (pass a campaign ID or sequence ID plus each lead’s email and a variables object), or includes variables on each lead in inboxjoy_leads_import.

  • Lookup order: the built-in field (firstName, lastName, company, title, email), then the campaign value for that lead, then the lead’s custom field of the same name.
  • Names: letters, digits, and underscores, starting with a letter (up to 64 characters). Values are trimmed and limited to 1,000 characters.
  • Updates merge: new keys are added or overwritten, other keys stay, and null deletes a key.
  • Launch check: a campaign launches once every lead in its audience has a value for every custom variable its steps use. The tool response lists leads that still miss values.
  • Automatic enrollment: leads added to a live campaign enroll as soon as their values are complete, and queued emails that have not been attempted pick up new values.
  • See what is missing: inboxjoy_campaigns_getLeadVariables returns, per variable, how many audience leads are ready or missing, plus a paged list of leads with each value and whether it comes from the campaign or the lead. Filter to the leads that miss a value, then fill them with inboxjoy_campaigns_setLeadVariables.
  • Older merge tags keep working: spellings such as {{first_name}}, {{FirstName}}, and {{company_name}} fill from the matching built-in field.
  • Several campaigns at once: a lead can be active in more than one campaign, with its own values in each.

Ask your agent to complete a task

The tools map directly to InboxJoy operations. You can ask your agent:

  • “Import this list of 80 leads from my CRM export into a list called Q3 outbound.”
  • “Draft a 4-step sequence for operations leaders about reducing manual lead routing.”
  • “Write a one-line icebreaker for each lead in Q3 outbound and save it as the icebreaker variable on that campaign.”
  • “Which leads in Q3 outbound still need an icebreaker?”
  • “Launch that campaign to the Q3 outbound list from my main mailbox.”
  • “How is the campaign performing so far?”

Revoke an agent’s access

Open Settings → MCP. Find the app and review the scopes on its active OAuth grant. Click Revoke to invalidate its tokens immediately.