Docs Home Beam MCP APIs

Lightmeter MCP

Remote MCP server for Lightmeter outbound campaign workspaces

How to Connect to MCP

Lightmeter MCP lets AI agents interact with your Lightmeter account and outbound campaign workspaces using your regular Lightmeter login. All actions are tracked (labelled 'MCP') and visible in the Activity Log of your account.

Get setup by searching for the 'Lightmeter' app in ChatGPT or Codex, or pointing your AI agent at this documentation page, which contains all the info required for the agent to gain access.

Server Endpoint

MCP
https://mcp.lightmeter.io/mcp

Authentication

OAuth sign-in with your Lightmeter account. You do not need to copy or store an API key.

Workspace Access

MCP can access all workspaces that your Lightmeter login supports.

Connection Details

Field Value
Display name Lightmeter
Server URL https://mcp.lightmeter.io/mcp
Authentication OAuth sign-in with your Lightmeter account

Available Tools

Connected clients can use these tools after you authorize access.

Tool Purpose
workspaces_list List workspaces available to the signed-in account.
campaigns_list List campaigns in a workspace, with filters for status, search, deletion state, and completion deadline state.
campaigns_get Retrieve one campaign and its sequence details.
campaign_creative_get Retrieve the editable Creative working copy and step settings for one campaign.
campaign_creative_update Write Creative subject/body fields and planned subject eligibility by step and variant, optionally updating step settings such as threading and delay days. Existing fields require overwrite_existing=true.
campaign_creative_approve Approve the Creative working copy as an immutable snapshot and mark it Ready for future campaign sends.
campaign_subject_pause_set Enable or disable one current subject on the Ready Creative without editing or reapproving its shared body. At least one subject for the body remains enabled.
campaign_analytics_lifetime_get Retrieve lifetime totals, rates, rate context, and drilldowns for one campaign.
campaign_analytics_timeseries_get Retrieve date-grained campaign analytics by day, week, month, or total.
campaign_analytics_sequence_get Retrieve date-grained performance by step, shared-body variant, and stable subject revision, including its source Creative document ID when available, current enabled or disabled state, and retired history with sends.
campaign_analytics_leads_list List lead-level campaign analytics with sorting and pagination.
campaign_lead_activity_list List chronological activity for one campaign lead.
campaign_replies_list List qualified human reply excerpts and classifications for a campaign and date range.
unibox_threads_list List Unibox threads with filters for answer status, campaign, mailbox, conversation classification, reply primary category, and reply subcategory.
unibox_thread_get Retrieve one Unibox thread with chronological messages, current answer status, classification evidence, and reply context.
unibox_thread_reply_send Send a validated plaintext reply from a workspace mailbox identity with stale-message checks, sender validation, idempotency, and rate-limit feedback.
campaign_lead_quality_diagnostics_get Retrieve lead-quality diagnostics for a campaign, including email verification counts and unavailable signals.
workspace_analytics_overview_get Retrieve workspace-level analytics for a date range.
workspace_report_summary_get Retrieve the workspace summary report for a date range.
workspace_report_campaigns_get Retrieve the workspace campaigns report.
workspace_report_campaign_performance_get Retrieve campaign performance segmentation from the reports surface.
workspace_report_engagement_performance_get Retrieve engagement performance trends for a date range.
workspace_report_engagement_reply_breakdown_get Retrieve categorized reply breakdowns and examples for a date range.
workspace_report_deliverability_get Retrieve deliverability, list quality, bounce, and box-host report data for a date range.
workspace_report_volume_get Retrieve volume, planned capacity, and utilization report data for a date range.
workspace_report_stocks_get Retrieve current lead stock and runway report data.
campaign_send_timeline_get Retrieve the campaign send timeline projection shown in the campaign editor.
campaigns_submit Create and submit a draft campaign for review.
campaign_leads_add Add leads to an existing campaign.

Creative MCP tools follow the same contract as the Campaigns API Creative endpoints. Use MCP when you want OAuth sign-in through a connected client; use the public API directly when you want API-key access.

Creative Writeback

Use campaign_creative_update to save one or more numbered subjects above one shared body in the editable Creative working copy. This does not approve the content or change the Ready snapshot. Use campaign_creative_approve only when the working copy should become an immutable approved snapshot and be marked Ready for future sends. Afterward, use campaign_analytics_sequence_get to compare evidence and campaign_subject_pause_set to enable or disable one current subject.

Update Example

{ "workspace_id": "workspace-uuid", "campaign_id": "campaign-uuid", "overwrite_existing": true, "documents": [ { "step_number": 1, "variant_number": 1, "field_type": "subject", "subject_number": 1, "plain_text": "Quick question for {{first_name}}" }, { "step_number": 1, "variant_number": 1, "field_type": "subject", "subject_number": 2, "is_disabled": true, "plain_text": "An idea for {{company_name}}" }, { "step_number": 1, "variant_number": 1, "field_type": "body", "subject_number": 1, "plain_text": "Hi {{first_name}}, noticed your work at {{company_name}}..." } ], "step_settings": [ { "step_number": 2, "wait_days": 3, "is_threaded": true } ] }

Related Documentation