BrandMochi API reference

Connect through BrandMochi OAuth using https://brandmochi.com/.well-known/oauth-authorization-server. The machine-readable contract is available as OpenAPI JSON or OpenAPI YAML.

OAuth clients use dynamic registration and PKCE. Existing operator automation may continue using the configured admin bearer token.

To use these operations from chat, follow the Claude and ChatGPT connection guide.

Operations

GET /api/v1/me/workspaces

List my workspaces

List the teams and brands the signed-in customer can access, including role and permissions.

Scope: mcp:read

GET /api/v1/teams/{teamId}/brands/{brandId}/actions

List brand actions

List the open work queue for a customer brand.

Scope: mcp:read

POST /api/v1/teams/{teamId}/brands/{brandId}/actions

Create a brand action

Add a social or domain action to an authorized customer brand.

Scope: mcp:write

POST /api/v1/teams/{teamId}/brands/{brandId}/actions/{actionId}/reserve

Reserve a brand action

Reserve an open customer action for the signed-in user.

Scope: mcp:write

POST /api/v1/teams/{teamId}/brands/{brandId}/actions/{actionId}/transition

Update a brand action

Complete, release, or archive an authorized customer action.

Scope: mcp:write

GET /api/v1/teams/{teamId}/brands/{brandId}/actions/{actionId}

Read a brand action

Read an action, source evidence, suggested copy, workflow, feedback history, notes, and events, including completed or archived actions.

Scope: mcp:read

POST /api/v1/teams/{teamId}/brands/{brandId}/actions/{actionId}/feedback

Record action feedback

Record a match label and optional note without completing or archiving the action. Notes attached to feedback are limited to 300 characters.

Scope: mcp:write

POST /api/v1/teams/{teamId}/brands/{brandId}/actions/{actionId}/notes

Add an action note

Append an operational note without changing feedback labels, reservation, or action status. Allows 1 to 2000 characters and supports closed actions.

Scope: mcp:write

POST /api/v1/teams/{teamId}/brands/{brandId}/actions/{actionId}/official-social-outcome

Record an official-post suggestion outcome

Record used_suggestion, did_not_use, or not_useful for an official social reminder using the website's outcome workflow. Requires brand management permission; does not publish to a social network.

Scope: mcp:write

POST /api/v1/teams/{teamId}/brands/{brandId}/official-social/{platform}/posts

Record an official social post

Record that a post was already published on a connected official account and advance its check cadence. Requires brand management permission; does not publish to a social network.

Scope: mcp:write

GET /api/v1/teams/{teamId}/brands/{brandId}/leads/tags

List brand lead tags

List customer-visible lead sources and segments for an authorized brand.

Scope: mcp:read

POST /api/v1/teams/{teamId}/brands/{brandId}/leads/tags/{tagId}/assignments

Assign brand leads to a tag

Add authorized brand leads to a customer-visible source or campaign segment with an audit reason.

Scope: mcp:write

POST /api/v1/teams/{teamId}/brands/{brandId}/leads/enrich/apollo

Enrich brand leads with Apollo

Queue work-email, role, company, and LinkedIn enrichment for authorized brand leads.

Scope: mcp:write

GET /api/v1/teams/{teamId}/brands/{brandId}/leads

List brand leads

List prospective customers and lead summary data for an authorized brand.

Scope: mcp:read

GET /api/v1/teams/{teamId}/brands/{brandId}/leads/{leadId}

Get a brand lead

Read one prospective customer with contact methods, evidence, and activity.

Scope: mcp:read

POST /api/v1/teams/{teamId}/brands/{brandId}/leads/{leadId}/status

Update lead status

Mark a customer lead new, contacted, or dismissed using the same workflow as the BrandMochi app.

Scope: mcp:write

POST /api/v1/teams/{teamId}/brands/{brandId}/leads/{leadId}/contacts

Record lead contact

Log a customer contact event and mark the lead contacted.

Scope: mcp:write

POST /api/v1/teams/{teamId}/brands/{brandId}/outreach/mailbox

Connect outreach mailbox

Verify and save encrypted SMTP and IMAP credentials for a customer-owned outreach mailbox.

Scope: mcp:write

GET /api/v1/teams/{teamId}/brands/{brandId}/outreach/campaigns

List outreach campaigns

List outreach campaigns and aggregate delivery, failure, and open counts for an authorized brand.

Scope: mcp:read

GET /api/v1/teams/{teamId}/brands/{brandId}/outreach/campaigns/{campaignId}

Get outreach campaign

Read one campaign, its sequence, targeting tags, personalization state, and aggregate results.

Scope: mcp:read

GET /api/v1/teams/{teamId}/brands/{brandId}/outreach/campaigns/{campaignId}/deliveries

List outreach deliveries

List recipient-level delivery, open, lead, and personalization evidence for a campaign.

Scope: mcp:read

POST /api/v1/teams/{teamId}/brands/{brandId}/outreach/campaigns/{campaignId}/automation

Set automatic outreach

Opt a campaign into automatically emailing eligible existing and future Lead Finder prospects, or turn automatic enrollment off. Keeps the campaign’s current live or paused state and sending limits.

Scope: mcp:write

POST /api/v1/teams/{teamId}/brands/{brandId}/outreach/campaigns/{campaignId}/state

Activate or pause outreach

Activate or pause a ready outreach campaign for an authorized customer brand.

Scope: mcp:write

POST /api/v1/admin/ops/leads/restore

Restore brand leads

Restore archived leads through the shared lead workflow and retain the reason on each lead event.

Scope: mcp:write

POST /api/v1/admin/ops/leads/tag

Assign a lead segment

Assign brand leads to a customer-visible tag through the shared lead workflow.

Scope: mcp:write

POST /api/v1/admin/ops/leads/enrich/apollo

Enrich brand leads with Apollo

Queue bounded Apollo enrichment through the shared BrandMochi lead workflow.

Scope: mcp:write

GET /api/v1/admin/ops/lead-research-queues

List lead research queues

List a brand's lead research targeting for operator maintenance.

Scope: mcp:read

POST /api/v1/admin/ops/lead-research-queues/{queueId}

Update lead research queue

Update a brand's lead research targeting with an operator audit reason.

Scope: mcp:write

POST /api/v1/admin/ops/leads/archive

Archive brand leads

Archive out-of-scope leads through the shared lead workflow and retain the reason on each lead event.

Scope: mcp:write

POST /api/v1/admin/ops/outreach/campaigns/{campaignId}/subject

Update outreach campaign subject

Update the initial campaign subject template and any unattempted queued deliveries.

Scope: mcp:write

GET /api/v1/admin/ops/health

Get operations health

Read BrandMochi operational health signals and source freshness.

Scope: mcp:read

GET /api/v1/admin/ops/schedules

List monitor schedules

List BrandMochi monitor and source schedules with state filters.

Scope: mcp:read

GET /api/v1/admin/ops/jobs

List durable jobs

List BrandMochi durable jobs with operational filters.

Scope: mcp:read

GET /api/v1/admin/ops/jobs/{jobId}

Get durable job

Read a durable job and its child jobs.

Scope: mcp:read

GET /api/v1/admin/ops/events

List operations events

List audited BrandMochi operations events.

Scope: mcp:read

POST /api/v1/admin/ops/monitor-runs

Start monitor run

Queue a scoped BrandMochi monitor run with an audit reason.

Scope: mcp:write

POST /api/v1/admin/ops/uspto-runs

Start USPTO collection

Queue a USPTO collection or recompaction run with an audit reason.

Scope: mcp:write

POST /api/v1/admin/ops/jobs/{jobId}/actions

Operate durable job

Stop, retry, replay, or release a durable job with an audit reason.

Scope: mcp:write

GET /api/v1/admin/articles

List articles

List operator article drafts and publication versions.

Scope: mcp:read

POST /api/v1/admin/articles

Create article draft

Create an audited draft using the existing D1 and R2 article lifecycle. Reconcile by slug before retrying.

Scope: mcp:write

GET /api/v1/admin/articles/{articleId}

Read article

Read an operator article and its complete stored body.

Scope: mcp:read

POST /api/v1/admin/articles/{articleId}

Save or publish article

Validate editor fields and save, publish, or schedule with optimistic concurrency, immutable bodies, and audit events. OAuth public writes require recent authentication; machine writes use the operator automation token.

Scope: mcp:write

POST /api/v1/admin/articles/{articleId}/media

Upload article image

Upload base64 image bytes through the verified, immutable article media workflow (10 MiB maximum). Returns the media URL; save it on the article separately.

Scope: mcp:write