MCP Tool Reference

    Every tool the BrandJet MCP server offers a connected app, with its parameters and annotations, read from the server's own tool list.

    Connect

    Point an MCP client at https://mcp.brandjet.ai/mcp over Streamable HTTP and sign in with OAuth. Setup steps for each client are on the MCP page. The REST API is in the API reference.

    read only
    the tool changes nothing.
    destructive
    the tool may change or remove existing data, not only add to it.
    idempotent
    calling it again with the same arguments has no further effect.
    open world
    the tool reaches services outside BrandJet.

    The same list is available as JSON and, with the REST endpoints, in llms-full.txt.

    96 Tools

    In the order the server lists them.

    brandjet_list_brandsbrandjet_switch_brandbrandjet_create_brandbrandjet_create_campaignbrandjet_get_campaignsbrandjet_get_campaign_analyticsbrandjet_list_campaign_resourcesbrandjet_configure_campaignbrandjet_campaign_actionbrandjet_get_campaign_lead_analyticsbrandjet_get_campaign_executionsbrandjet_create_mention_to_outreach_workflowbrandjet_get_conversationsbrandjet_update_conversationbrandjet_get_messagesbrandjet_send_messagebrandjet_manage_conversation_tagsbrandjet_manage_custom_viewsbrandjet_manage_automationsbrandjet_manage_tasksbrandjet_manage_teamsbrandjet_manage_snippetsbrandjet_send_outreach_messagebrandjet_get_proposalsbrandjet_create_proposalbrandjet_send_proposalbrandjet_get_proposalbrandjet_remind_proposalbrandjet_void_proposalbrandjet_update_proposal_outcomebrandjet_send_booking_linkbrandjet_get_meetingsbrandjet_cancel_meetingbrandjet_create_meetingbrandjet_get_availabilitybrandjet_get_lead_listsbrandjet_get_leadsbrandjet_create_leadbrandjet_update_leadbrandjet_manage_lead_listsbrandjet_get_lead_statsbrandjet_manage_lead_collectionsbrandjet_manage_crm_stagesbrandjet_manage_crm_leadsbrandjet_advanced_filter_leadsbrandjet_bulk_lead_operationsbrandjet_get_lead_timelinebrandjet_get_suppression_statusbrandjet_get_email_accountsbrandjet_manage_email_accountsbrandjet_get_integrationsbrandjet_manage_integrationsbrandjet_manage_website_analyticsbrandjet_get_website_analyticsbrandjet_get_website_analytics_breakdownbrandjet_get_mentionsbrandjet_get_mention_statsbrandjet_manage_mentionsbrandjet_mention_replybrandjet_get_sentiment_dashboardbrandjet_manage_shared_reportsbrandjet_get_agentsbrandjet_manage_agentsbrandjet_manage_agent_accountsbrandjet_get_agent_executionsbrandjet_manage_pending_repliesbrandjet_manage_llm_monitorsbrandjet_manage_personasbrandjet_get_available_modelsbrandjet_get_llm_dashboardbrandjet_get_llm_queriesbrandjet_manage_llm_queriesbrandjet_get_competitorsbrandjet_manage_competitorsbrandjet_competitor_actionbrandjet_get_support_ticketsbrandjet_create_support_ticketbrandjet_manage_support_ticketsbrandjet_list_all_toolsbrandjet_get_user_settingsbrandjet_manage_user_settingsbrandjet_get_brand_settingsbrandjet_manage_brand_settingsbrandjet_manage_brand_membersbrandjet_get_team_membersbrandjet_manage_email_warmupbrandjet_search_lead_databasebrandjet_find_contact_infobrandjet_enrich_leadsbrandjet_manage_search_resultsbrandjet_get_search_filtersbrandjet_get_enrichment_creditsbrandjet_get_enrichment_jobsbrandjet_manage_saved_searchesbrandjet_find_ui_elementbrandjet_get_tool_run

    brandjet_list_brands

    read only
    idempotent

    List all brands accessible to the current user. Returns each brand's id, name, description, website, industry, and isActive status, plus the currently selected brandId. Do NOT use for brand settings or configuration (use brandjet_get_brand_settings instead).

    No parameters.

    brandjet_switch_brand

    idempotent

    Switch the active brand for this session only. A new session of a login with several brands starts with no brand selected, so call this first whenever a session must work on a specific brand. Jobs that run in parallel on different brands should pass brandId on each tool call instead, or connect with an API key, which always works on the brand it was created for.

    • brandIdstringRequired

      Brand ID to switch to. Must be one of the IDs returned by brandjet_list_brands.

    brandjet_create_brand

    destructive

    Create a brand owned by the signed-in user, the same way adding a brand in the app does. It counts toward the plan's brand limit and is refused at the limit. The brand starts active with monitoring off: turn monitoring on with brandjet_manage_brand_settings (action toggle_monitoring). The session stays on its current brand, so call brandjet_switch_brand with the returned id to work on the new one. Needs a connection signed in through OAuth; API keys cannot create brands.

    • namestringRequired

      Brand name, as its customers know it (1-255 characters).

    • websitestringRequired

      Brand website, for example https://example.com. The name and the website domain become the brand keywords.

    • platformsstring[]Optional

      Platforms to monitor once monitoring is on. Defaults to twitter, reddit, youtube, news and linkedin.

      One of: twitter, reddit, youtube, news, linkedin, tiktok

    brandjet_create_campaign

    destructive

    Create a new outreach campaign for the current brand. Returns the campaign in DRAFT status. Optionally include a workflow definition with nodes and edges. For brand-new campaigns without attached leads, leave generated message configValues empty unless the user provided exact copy; add or revise message copy after leads are attached and exact variables are known.

    • namestringRequired

      Campaign name (e.g., "Summer Outreach 2024")

    • typestringRequired

      Campaign type. "email_sequence" for email-only flows. "outreach" for LinkedIn, multi-channel, or general outreach. "nurture" for long-term engagement. "sales" for direct sales sequences. Use "outreach" for LinkedIn-focused campaigns.

      One of: email_sequence, outreach, nurture, sales

    • descriptionstringOptional

      Campaign description

    • prioritystringOptional

      Priority level (default: medium)

      One of: low, medium, high, urgent

    • targetAudiencestringOptional

      Description of target audience

    • scheduledStartAtstringOptional

      Scheduled start date-time (ISO 8601)

    • scheduledEndAtstringOptional

      Scheduled end date-time (ISO 8601)

    • timezonestringOptional

      Timezone for sending schedule (e.g., "America/New_York")

    • sendingDaysstring[]Optional

      Days of week to send on

      One of: monday, tuesday, wednesday, thursday, friday, saturday, sunday

    • sendingTimeStartstringOptional

      Daily sending window start (HH:MM format, e.g., "09:00")

    • sendingTimeEndstringOptional

      Daily sending window end (HH:MM format, e.g., "17:00")

    • maxNewLeadsPerDayintegerOptional

      Maximum new leads to contact per day

    • prioritizeNewLeadsbooleanOptional

      Whether to prioritize new leads (default: false)

    • respectTimezonebooleanOptional

      Whether to respect lead timezone for sending (default: false)

    • trackOpensbooleanOptional

      Track email opens (default: true)

    • trackClicksbooleanOptional

      Track email link clicks (default: true)

    • trackUnsubscribesbooleanOptional

      Track unsubscribe events (default: false)

    • includeUnsubscribeLinkbooleanOptional

      Append a visible unsubscribe link to the email footer and send a one-click List-Unsubscribe header. Leave this off for 1-1 outreach, where the header can push mail into the Gmail Promotions tab; turn it on for marketing or high-volume sending (default: false)

    • gdprCompliantbooleanOptional

      Add GDPR compliance footer and unsubscribe handling to every email in this campaign (default: false)

    • canSpamCompliantbooleanOptional

      Add CAN-SPAM compliance footer and unsubscribe handling to every email in this campaign (default: false)

    • stopSendingTriggerstringOptional

      Stop sending to a lead when this event occurs (default: reply)

      One of: reply, click, open, bounce

    • enableProviderMatchingbooleanOptional

      Match email provider (e.g., Outlook to Outlook) (default: true)

    • workflowsobject[]Optional

      Workflow definitions. Each campaign typically has one workflow. Include a "start" node and action nodes (email, linkedin, etc.) connected via edges. Add delays by setting sendWhen="delay" with delayValue+delayUnit on the action node — do NOT create separate delay/wait nodes.

    • workflows[].namestringRequired

      Workflow name (e.g., "Main Sequence")

    • workflows[].descriptionstringOptional
    • workflows[].nodesobject[]Required

      Workflow nodes. Must include exactly one "start" node. To add delays between steps, set sendWhen="delay" with delayValue+delayUnit on the action node itself. To A/B test a step, set variantDistribution and a "variants" array on that action node.

    • workflows[].nodes[].nodeIdstringRequired

      Unique node identifier within the workflow (e.g., "node-1", "start-1")

    • workflows[].nodes[].labelstringRequired

      Display label for the node

    • workflows[].nodes[].typestringRequired

      Node type. Rules: (1) Every workflow must begin with exactly one "start" node. (2) Do NOT create separate delay/wait nodes — set sendWhen="delay" with delayValue+delayUnit on the action node. (3) "linkedin_invitation" = connection request, "linkedin" = direct message (requires existing connection). (4) For condition nodes, create two outgoing edges with label "No" (index 0) and "Yes" (index 1). For linkedin_invitation, use "Rejected" (index 0) and "Accepted" (index 1).

      One of: start, email, linkedin, linkedin_invitation, linkedin_profile_visit, linkedin_reaction, twitter, instagram, whatsapp, telegram, sms, condition_email_replied, condition_email_opened, condition_email_clicked, condition_linkedin_replied, condition_instagram_replied, condition_whatsapp_replied, condition_twitter_replied, condition_telegram_replied, condition_is_connected

    • workflows[].nodes[].statusstringOptional

      Set to "configured" when the node has all required configurations filled in. Default: action_needed.

      One of: action_needed, configured, draft

    • workflows[].nodes[].channelstringOptional

      Required for action nodes. Set to match the node type: email→"email", linkedin/linkedin_invitation/linkedin_profile_visit/linkedin_reaction→"linkedin", twitter→"twitter", instagram→"instagram", whatsapp→"whatsapp", telegram→"telegram".

      One of: email, linkedin, twitter, instagram, whatsapp, telegram, slack, sms

    • workflows[].nodes[].positionXnumberOptional

      Canvas X position for UI layout

    • workflows[].nodes[].positionYnumberOptional

      Canvas Y position for UI layout

    • workflows[].nodes[].titlestringOptional

      Alternative display title

    • workflows[].nodes[].sendWhenstringOptional

      IMPORTANT: Set to "delay" on an action node to wait before executing it. This is how you add delays between steps — NOT by creating separate delay nodes. The first action node after "start" should use "send_immediately" or omit this field. Example: a linkedin message node with sendWhen="delay", delayValue=2, delayUnit="days" will wait 2 days after the previous step before sending.

      One of: send_immediately, delay

    • workflows[].nodes[].delayValuenumberOptional

      How long to wait before executing this node (used when sendWhen="delay")

    • workflows[].nodes[].delayUnitstringOptional

      Time unit for delayValue (minutes, hours, days, weeks)

      One of: minutes, hours, days, weeks

    • workflows[].nodes[].configurationsobject[]Optional

      Node-specific configuration key-value pairs. When the node has A/B variants, these act as the shared defaults that each variant's configs override per key.

    • workflows[].nodes[].configurations[].configKeystringRequired

      Configuration key. Exact keys per node type: email→"subject","content","followUpToNodeId" (set followUpToNodeId to the nodeId of a previous email node to thread replies); linkedin→"message"; linkedin_invitation→REQUIRES BOTH "invitationNote" (200 char max including rendered personalization variables; LinkedIn rejects longer notes on non-Premium accounts) AND "timeWindowHours" (hours to wait before checking acceptance, e.g. "48" for 2 days, "72" for 3 days; never omit, otherwise the node falls back to the 72 hour default); linkedin_reaction→"reactionType" (one of: like, celebrate, support, love, insightful, funny); twitter→"message"; instagram→"message","followRequestTimeoutHours" (hours to wait for private account follow acceptance, default 168); whatsapp→"message"; telegram→"message"

    • workflows[].nodes[].configurations[].configValuestringOptional

      Configuration value. For message templates, use personalization variables with snake_case syntax: {{lead_name}}, {{first_name}}, {{last_name}}, {{lead_email}}, {{lead_phone}}, {{brand_name}}, {{sender_name}}, {{mention_content}}, {{mention_platform}}, {{mention_url}}, {{mention_sentiment}}, {{mention_date}}. Custom variables: {{custom.variable_name}} (e.g., {{custom.company_name}}). Only use placeholders returned by brandjet_get_campaigns with includeVariables=true when configuring an existing campaign. Do not invent helper expressions or camelCase variables like {{firstName}} or {{companyName}} because they fail validation.

    • workflows[].nodes[].configurations[].dataTypestringOptional

      Optional data type hint

    • workflows[].nodes[].variantDistributionstringOptional

      Enables A/B testing on this action node when set together with "variants". "equal" splits leads evenly across active variants; "manual" routes by each variant's weight; "auto_optimize" uses Thompson sampling on variantWinningMetric to shift traffic toward the better performer and declares a winner once every variant has at least variantMinSampleSize sends and one leads with 95% probability.

      One of: equal, manual, auto_optimize

    • workflows[].nodes[].variantWinningMetricstringOptional

      Metric used to compare variants and pick a winner. "reply_rate" or "positive_reply_rate" for message steps, "click_rate" for tracked email links, "connection_acceptance_rate" for linkedin_invitation nodes. Used by variantDistribution="auto_optimize"; defaults to "reply_rate".

      One of: reply_rate, positive_reply_rate, click_rate, connection_acceptance_rate

    • workflows[].nodes[].variantMinSampleSizeintegerOptional

      Minimum sends per variant before a winner can be declared under "auto_optimize". Default: 100.

    • workflows[].nodes[].variantsobject[]Optional

      A/B test variants for this action node (email, linkedin, linkedin_invitation, twitter, instagram, whatsapp, telegram). Provide at least two, each with a unique single-letter variantKey. Put the shared copy in node "configurations" and only the differing keys (e.g., "subject", "content", "message", "invitationNote") in each variant's configs. Set variantDistribution on the node when using variants. Omit entirely for a node with no A/B test. Per-variant results are not exposed through the MCP analytics tools yet; view them on the campaign Analytics page in the app.

    • workflows[].nodes[].variants[].variantKeystringRequired

      Single uppercase letter identifying the variant ("A", "B", "C", ...). Must be unique within the node. Use "A" for the control.

    • workflows[].nodes[].variants[].weightnumberOptional

      Share of leads routed to this variant, 0-100. Only used when the node has variantDistribution="manual"; weights across the node's variants should sum to 100. Default: 50.

    • workflows[].nodes[].variants[].isControlbooleanOptional

      Mark exactly one variant per node as the control (baseline). Default: false.

    • workflows[].nodes[].variants[].senderAccountIdstringOptional

      Optional: send this variant from a specific account instead of the campaign rotation. Must be an account already linked to the campaign (see brandjet_list_campaign_resources). Set senderAccountType alongside it.

    • workflows[].nodes[].variants[].senderAccountTypestringOptional

      Type of senderAccountId: "email" for email accounts, "social" for LinkedIn/Twitter/Instagram/WhatsApp/Telegram integrations, "mailbox" for managed mailboxes.

      One of: email, social, mailbox

    • workflows[].nodes[].variants[].delayValuenumberOptional

      Optional: override the node-level delayValue for this variant only (to test send timing).

    • workflows[].nodes[].variants[].delayUnitstringOptional

      Time unit for the variant delayValue override

      One of: minutes, hours, days, weeks

    • workflows[].nodes[].variants[].configsobject[]Optional

      Variant-specific configuration overrides using the same configKey/configValue pairs as node "configurations" (e.g., a different "subject" or "content" for email, a different "message" for linkedin). Keys not listed here fall back to the node-level configurations, so only include the keys this variant changes.

    • workflows[].edgesobject[]Required

      Edges connecting nodes by their nodeId.

    • workflows[].edges[].edgeIdstringRequired

      Unique edge identifier within the workflow

    • workflows[].edges[].sourceNodeIdstringRequired

      Source node nodeId

    • workflows[].edges[].targetNodeIdstringRequired

      Target node nodeId

    • workflows[].edges[].labelstringOptional

      Edge label. For condition nodes: "No" (index 0) or "Yes" (index 1). For linkedin_invitation: "Rejected" (index 0) or "Accepted" (index 1). Must be capitalized.

    • workflows[].edges[].conditionstringOptional

      Condition logic expression

    • workflows[].edges[].isActivebooleanOptional

      Whether this edge is active (default: true)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_campaigns

    read only
    idempotent

    Get campaigns for the current brand. Without campaignId: lists all campaigns. With campaignId: returns full details, optionally including workflow, lead stats, and linked accounts. Use brandjet_get_team_members to resolve ownerId into a readable name/email.

    • campaignIdstringOptional

      Campaign ID. If provided, returns full details. If omitted, lists all campaigns for the current brand.

    • includeWorkflowbooleanOptional

      Include workflow definition with nodes and edges (only when campaignId is provided, default: false)

    • includeVariablesbooleanOptional

      Include available personalization variables for message templates. Returns exact placeholder strings like {{first_name}}, {{lead_name}}, {{brand_name}}, and custom variables from campaign leads such as {{custom.company_name}}. Use this before configuring a workflow to know exactly which placeholders are valid. (only when campaignId is provided, default: false)

    • includeLeadStatsbooleanOptional

      Include lead statistics by channel (only when campaignId is provided, default: false)

    • includeAccountsbooleanOptional

      Include linked sending accounts (only when campaignId is provided, default: false)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_campaign_analytics

    read only
    idempotent

    Get aggregate campaign analytics for the current brand or a single campaign. Use this for questions like "how many emails did we send today?", "sent count this week", "replies yesterday", or channel-level outreach performance. Returns direct sent counts and channel breakdowns so you do not need to page through execution logs.

    • campaignIdstringOptional

      Optional campaign ID. Omit to aggregate across every campaign in the current brand workspace.

    • timeframestringOptional

      Time range shortcut. Use "today" for questions like "how many emails did we send today?". Use "custom" with dateFrom/dateTo for a specific range. Default: today.

      One of: today, yesterday, last_7_days, last_30_days, custom

    • dateFromstringOptional

      Custom start date in YYYY-MM-DD or ISO format. Only needed when timeframe is custom.

    • dateTostringOptional

      Custom end date in YYYY-MM-DD or ISO format, inclusive. Only needed when timeframe is custom.

    • channelstringOptional

      Optional channel filter. Use "email" for email-specific send counts, "linkedin" for LinkedIn outreach, etc.

      One of: email, linkedin, twitter, instagram, whatsapp, telegram, slack, sms

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_list_campaign_resources

    read only
    idempotent

    List all available resources for building campaigns: lead lists, email accounts, and integration accounts (LinkedIn, Twitter, etc.) for the current brand. Call this before configuring a campaign to see what is available. Lists the email accounts and LinkedIn, X (Twitter), Instagram, WhatsApp and Telegram accounts you can use in campaigns. Each account includes canSend (bool) and canSendReason (email: error | disconnected | pending | reply_tracking_disabled; integrations: disabled | error | inactive | pending | requires_review | rate_limited; null when it can send) so you can filter unhealthy accounts without combining raw status + isEnabled yourself.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_configure_campaign

    destructive

    Configure a campaign by adding leads, linking sending accounts, and/or setting the workflow. Each section is optional. Leads are additive (merged with existing). Accounts default to replace mode — account selection MUST be operator-confirmed via accounts.confirmed: true. Call brandjet_list_campaign_resources first to see the brand's full sendable pool before attaching accounts. Call brandjet_get_campaigns with includeVariables=true before writing message templates; invalid placeholders are rejected. Workflow is fully replaced. Lead list IDs and lead IDs must come from a brandjet_get_lead_lists or brandjet_get_leads call made in this same conversation turn; stale or invented IDs are rejected with a not-found error. Related tools: brandjet_campaign_action (launch after configuring), brandjet_get_campaigns (view current config).

    • campaignIdstringRequired

      Campaign ID to configure

    • settingsobjectOptional

      Campaign-level settings. Every field here can be changed on an existing campaign, including maxNewLeadsPerDay and the sending schedule — never create a duplicate campaign just to change a setting. Applied before the leads block in the same call.

    • settings.verifiedOnlybooleanOptional

      When true, unverified leads are filtered out when attaching lists or ID sets. Applied before the leads block so attachments in this same call respect it. Defaults to false; reliable verification requires a future verifier integration.

    • settings.namestringOptional

      Rename the campaign

    • settings.descriptionstringOptional

      Campaign description

    • settings.prioritystringOptional

      Priority level

      One of: low, medium, high, urgent

    • settings.targetAudiencestringOptional

      Description of target audience

    • settings.maxNewLeadsPerDayintegerOptional

      Daily cap on how many new leads the campaign starts contacting. Change this here; it does not require creating a new campaign.

    • settings.prioritizeNewLeadsbooleanOptional

      Prioritise new leads over follow-ups when the daily cap is reached

    • settings.timezonestringOptional

      Timezone for the sending schedule (e.g., "America/New_York")

    • settings.sendingDaysstring[]Optional

      Days of week to send on

      One of: monday, tuesday, wednesday, thursday, friday, saturday, sunday

    • settings.sendingTimeStartstringOptional

      Daily sending window start (HH:MM, e.g., "09:00")

    • settings.sendingTimeEndstringOptional

      Daily sending window end (HH:MM, e.g., "17:00")

    • settings.respectTimezonebooleanOptional

      Respect each lead timezone when sending

    • settings.trackOpensbooleanOptional

      Track email opens

    • settings.trackClicksbooleanOptional

      Track email link clicks

    • settings.trackUnsubscribesbooleanOptional

      Track unsubscribe events

    • settings.includeUnsubscribeLinkbooleanOptional

      Append a visible unsubscribe link to the email footer and send a one-click List-Unsubscribe header. Leave this off for 1-1 outreach, where the header can push mail into the Gmail Promotions tab; turn it on for marketing or high-volume sending

    • settings.gdprCompliantbooleanOptional

      Add GDPR compliance footer and unsubscribe handling to every email in this campaign

    • settings.canSpamCompliantbooleanOptional

      Add CAN-SPAM compliance footer and unsubscribe handling to every email in this campaign

    • settings.stopSendingTriggerstringOptional

      Stop sending to a lead when this event occurs

      One of: reply, click, open, bounce

    • settings.enableProviderMatchingbooleanOptional

      Match email provider (e.g., Outlook to Outlook)

    • settings.scheduledStartAtstringOptional

      Scheduled start date-time (ISO 8601)

    • settings.scheduledEndAtstringOptional

      Scheduled end date-time (ISO 8601)

    • leadsobjectOptional

      Leads to add to the campaign. Multiple methods can be combined in one call.

    • leads.fromListIdsstring[]Optional

      Add leads from these lead list IDs

    • leads.qualifiedOnlybooleanOptional

      With fromListIds: add only leads the AI qualification marked as qualified (customVariables.qualification_status = "qualified")

    • leads.byIdsstring[]Optional

      Add specific lead IDs directly

    • leads.manualobject[]Optional

      Manually defined leads to create and add, up to 500 per call. Leads are matched to existing brand leads by email, phone or profile URL, so re-sending the same lead never creates a duplicate.

    • leads.manual[].namestringOptional

      Lead name

    • leads.manual[].emailstringOptional

      Lead email address

    • leads.manual[].phoneNumberstringOptional

      Lead phone number

    • leads.manual[].linkedinProfileUrlstringOptional

      LinkedIn profile URL

    • leads.manual[].twitterProfileUrlstringOptional

      Twitter/X profile URL

    • leads.manual[].instagramProfileUrlstringOptional

      Instagram profile URL

    • leads.manual[].customVariablesobjectOptional

      Custom personalization variables as key-value pairs

    • accountsobjectOptional

      Sending accounts to link to the campaign. Account selection MUST be operator-confirmed. Pass accounts.confirmed: true to apply changes.

    • accounts.accountIdsstring[]Optional

      Specific email account or integration IDs to link

    • accounts.selectAllbooleanOptional

      Select all brand accounts matching the type/provider filters

    • accounts.typestringOptional

      Filter accounts by type (used with selectAll)

      One of: email, social

    • accounts.providerstringOptional

      Filter accounts by provider (used with selectAll)

      One of: google, outlook, smtp, twitter, linkedin, instagram, whatsapp

    • accounts.replacebooleanOptional

      Replace existing accounts (true) or merge with existing (false). Default: true

    • accounts.confirmedbooleanOptional

      Required true to apply account changes when narrowing or replacing the active sender pool. Without it, a preview of the proposed change is returned. Always call brandjet_list_campaign_resources first to see the full sendable pool.

    • workflowobjectOptional

      Replace the campaign workflow entirely. The full workflow (nodes + edges) must be provided.

    • workflow.namestringRequired

      Workflow name (e.g., "Main Sequence")

    • workflow.descriptionstringOptional
    • workflow.nodesobject[]Required

      Workflow nodes. Must include exactly one "start" node. To add delays between steps, set sendWhen="delay" with delayValue+delayUnit on the action node itself. To A/B test a step, set variantDistribution and a "variants" array on that action node.

    • workflow.nodes[].nodeIdstringRequired

      Unique node identifier within the workflow (e.g., "node-1", "start-1")

    • workflow.nodes[].labelstringRequired

      Display label for the node

    • workflow.nodes[].typestringRequired

      Node type. Rules: (1) Every workflow must begin with exactly one "start" node. (2) Do NOT create separate delay/wait nodes — set sendWhen="delay" with delayValue+delayUnit on the action node. (3) "linkedin_invitation" = connection request, "linkedin" = direct message (requires existing connection). (4) For condition nodes, create two outgoing edges with label "No" (index 0) and "Yes" (index 1). For linkedin_invitation, use "Rejected" (index 0) and "Accepted" (index 1).

      One of: start, email, linkedin, linkedin_invitation, linkedin_profile_visit, linkedin_reaction, twitter, instagram, whatsapp, telegram, sms, condition_email_replied, condition_email_opened, condition_email_clicked, condition_linkedin_replied, condition_instagram_replied, condition_whatsapp_replied, condition_twitter_replied, condition_telegram_replied, condition_is_connected

    • workflow.nodes[].statusstringOptional

      Set to "configured" when the node has all required configurations filled in. Default: action_needed.

      One of: action_needed, configured, draft

    • workflow.nodes[].channelstringOptional

      Required for action nodes. Set to match the node type: email→"email", linkedin/linkedin_invitation/linkedin_profile_visit/linkedin_reaction→"linkedin", twitter→"twitter", instagram→"instagram", whatsapp→"whatsapp", telegram→"telegram".

      One of: email, linkedin, twitter, instagram, whatsapp, telegram, slack, sms

    • workflow.nodes[].positionXnumberOptional

      Canvas X position for UI layout

    • workflow.nodes[].positionYnumberOptional

      Canvas Y position for UI layout

    • workflow.nodes[].titlestringOptional

      Alternative display title

    • workflow.nodes[].sendWhenstringOptional

      IMPORTANT: Set to "delay" on an action node to wait before executing it. This is how you add delays between steps — NOT by creating separate delay nodes. The first action node after "start" should use "send_immediately" or omit this field. Example: a linkedin message node with sendWhen="delay", delayValue=2, delayUnit="days" will wait 2 days after the previous step before sending.

      One of: send_immediately, delay

    • workflow.nodes[].delayValuenumberOptional

      How long to wait before executing this node (used when sendWhen="delay")

    • workflow.nodes[].delayUnitstringOptional

      Time unit for delayValue (minutes, hours, days, weeks)

      One of: minutes, hours, days, weeks

    • workflow.nodes[].configurationsobject[]Optional

      Node-specific configuration key-value pairs. When the node has A/B variants, these act as the shared defaults that each variant's configs override per key.

    • workflow.nodes[].configurations[].configKeystringRequired

      Configuration key. Exact keys per node type: email→"subject","content","followUpToNodeId" (set followUpToNodeId to the nodeId of a previous email node to thread replies); linkedin→"message"; linkedin_invitation→REQUIRES BOTH "invitationNote" (200 char max including rendered personalization variables; LinkedIn rejects longer notes on non-Premium accounts) AND "timeWindowHours" (hours to wait before checking acceptance, e.g. "48" for 2 days, "72" for 3 days; never omit, otherwise the node falls back to the 72 hour default); linkedin_reaction→"reactionType" (one of: like, celebrate, support, love, insightful, funny); twitter→"message"; instagram→"message","followRequestTimeoutHours" (hours to wait for private account follow acceptance, default 168); whatsapp→"message"; telegram→"message"

    • workflow.nodes[].configurations[].configValuestringOptional

      Configuration value. For message templates, use personalization variables with snake_case syntax: {{lead_name}}, {{first_name}}, {{last_name}}, {{lead_email}}, {{lead_phone}}, {{brand_name}}, {{sender_name}}, {{mention_content}}, {{mention_platform}}, {{mention_url}}, {{mention_sentiment}}, {{mention_date}}. Custom variables: {{custom.variable_name}} (e.g., {{custom.company_name}}). Only use placeholders returned by brandjet_get_campaigns with includeVariables=true when configuring an existing campaign. Do not invent helper expressions or camelCase variables like {{firstName}} or {{companyName}} because they fail validation.

    • workflow.nodes[].configurations[].dataTypestringOptional

      Optional data type hint

    • workflow.nodes[].variantDistributionstringOptional

      Enables A/B testing on this action node when set together with "variants". "equal" splits leads evenly across active variants; "manual" routes by each variant's weight; "auto_optimize" uses Thompson sampling on variantWinningMetric to shift traffic toward the better performer and declares a winner once every variant has at least variantMinSampleSize sends and one leads with 95% probability.

      One of: equal, manual, auto_optimize

    • workflow.nodes[].variantWinningMetricstringOptional

      Metric used to compare variants and pick a winner. "reply_rate" or "positive_reply_rate" for message steps, "click_rate" for tracked email links, "connection_acceptance_rate" for linkedin_invitation nodes. Used by variantDistribution="auto_optimize"; defaults to "reply_rate".

      One of: reply_rate, positive_reply_rate, click_rate, connection_acceptance_rate

    • workflow.nodes[].variantMinSampleSizeintegerOptional

      Minimum sends per variant before a winner can be declared under "auto_optimize". Default: 100.

    • workflow.nodes[].variantsobject[]Optional

      A/B test variants for this action node (email, linkedin, linkedin_invitation, twitter, instagram, whatsapp, telegram). Provide at least two, each with a unique single-letter variantKey. Put the shared copy in node "configurations" and only the differing keys (e.g., "subject", "content", "message", "invitationNote") in each variant's configs. Set variantDistribution on the node when using variants. Omit entirely for a node with no A/B test. Per-variant results are not exposed through the MCP analytics tools yet; view them on the campaign Analytics page in the app.

    • workflow.nodes[].variants[].variantKeystringRequired

      Single uppercase letter identifying the variant ("A", "B", "C", ...). Must be unique within the node. Use "A" for the control.

    • workflow.nodes[].variants[].weightnumberOptional

      Share of leads routed to this variant, 0-100. Only used when the node has variantDistribution="manual"; weights across the node's variants should sum to 100. Default: 50.

    • workflow.nodes[].variants[].isControlbooleanOptional

      Mark exactly one variant per node as the control (baseline). Default: false.

    • workflow.nodes[].variants[].senderAccountIdstringOptional

      Optional: send this variant from a specific account instead of the campaign rotation. Must be an account already linked to the campaign (see brandjet_list_campaign_resources). Set senderAccountType alongside it.

    • workflow.nodes[].variants[].senderAccountTypestringOptional

      Type of senderAccountId: "email" for email accounts, "social" for LinkedIn/Twitter/Instagram/WhatsApp/Telegram integrations, "mailbox" for managed mailboxes.

      One of: email, social, mailbox

    • workflow.nodes[].variants[].delayValuenumberOptional

      Optional: override the node-level delayValue for this variant only (to test send timing).

    • workflow.nodes[].variants[].delayUnitstringOptional

      Time unit for the variant delayValue override

      One of: minutes, hours, days, weeks

    • workflow.nodes[].variants[].configsobject[]Optional

      Variant-specific configuration overrides using the same configKey/configValue pairs as node "configurations" (e.g., a different "subject" or "content" for email, a different "message" for linkedin). Keys not listed here fall back to the node-level configurations, so only include the keys this variant changes.

    • workflow.edgesobject[]Required

      Edges connecting nodes by their nodeId.

    • workflow.edges[].edgeIdstringRequired

      Unique edge identifier within the workflow

    • workflow.edges[].sourceNodeIdstringRequired

      Source node nodeId

    • workflow.edges[].targetNodeIdstringRequired

      Target node nodeId

    • workflow.edges[].labelstringOptional

      Edge label. For condition nodes: "No" (index 0) or "Yes" (index 1). For linkedin_invitation: "Rejected" (index 0) or "Accepted" (index 1). Must be capitalized.

    • workflow.edges[].conditionstringOptional

      Condition logic expression

    • workflow.edges[].isActivebooleanOptional

      Whether this edge is active (default: true)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_campaign_action

    destructive

    Perform an action on a campaign: launch (start executing), pause (stop execution), resume (continue after pause), or remove_leads (take the leads in leadIds out of the campaign and cancel their remaining sequence steps, e.g. when a lead books a meeting). Launch, resume and remove_leads require confirmed: true to actually fire. Without it (or with dryRun: true), a preview is returned instead. When the launch preview includes warmupRisk (a sending mailbox has warmup off or is under day 14), the launch also requires acknowledgeWarmupRisk: true after the human operator accepts that risk. Always review the preview before confirming. Related tools: brandjet_get_campaigns (view status), brandjet_configure_campaign (set up before launch), brandjet_get_campaign_executions (view execution logs after launch).

    • campaignIdstringRequired

      Campaign ID

    • actionstringRequired

      Action to perform on the campaign. "remove_leads" takes the leads in leadIds out of the campaign and cancels any sequence steps still pending for them, e.g. once a lead books a meeting.

      One of: launch, pause, resume, remove_leads

    • selectAllbooleanOptional

      Launch for all campaign leads. Defaults to false when leadIds is given and to true otherwise. Only used with "launch" action.

    • leadIdsstring[]Optional

      Specific lead IDs. With "launch", the leads to launch for; the reply then estimates leadsStartingToday, leadsWaitingForNextWindow (leads the campaign cannot start today because of its daily new lead limit, its sending accounts or its sending schedule; they start automatically from the next sending window as capacity allows) and leadsAlreadyStarted. With "remove_leads" (required), the leads to take out of the campaign.

    • scheduledStartAtstringOptional

      ISO 8601 datetime to schedule the launch. If omitted, launches immediately. Only used with "launch" action.

    • timezonestringOptional

      Timezone for the sending schedule (e.g., "America/New_York"). Only used with "launch" action.

    • dryRunbooleanOptional

      If true, validate and preview the launch without sending. Returns total leads, capacity preview, account health, and any blockers/warnings. Only used with "launch" action. Strongly recommended before the first real launch of a campaign.

    • confirmedbooleanOptional

      Required true to actually execute a launch, resume or remove_leads. When omitted or false, the tool auto-routes to a preview (same as dryRun) and returns needsConfirmation: true. Pass confirmed: true after reviewing the preview to fire.

    • acknowledgeDeliverabilityRiskbooleanOptional

      Required true (in addition to confirmed) to resume a campaign that was auto-paused for reputation risk (high bounce/complaint rate). Only pass after the human operator has explicitly accepted the deliverability risk shown in the preview.

    • acknowledgeWarmupRiskbooleanOptional

      Required true (in addition to confirmed) to launch when the preview reports warmupRisk, meaning a linked sending mailbox has warmup off or is under day 14 of warmup. Only pass after the human operator has explicitly accepted the spam-placement risk listed in the preview; never set it on your own.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_campaign_lead_analytics

    read only
    idempotent

    Get campaign lead analytics for the current campaign. Returns paginated lead workflow progress, execution status, current step, per-step metrics, and errors. Use this for questions about stuck leads, failed steps, lead progress, and why a campaign is not advancing.

    • campaignIdstringRequired

      Campaign ID

    • pageintegerOptional

      Page number (default: 1)

    • limitintegerOptional

      Results per page (default: 25, max: 50)

    • searchstringOptional

      Search leads by name or email

    • statusstringOptional

      Filter by execution status

      One of: pending, running, completed, failed, cancelled, paused

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_campaign_executions

    read only
    idempotent

    Get paginated execution steps across all leads in a campaign. Each row includes the step status, workflow node, and delivery events (sentAt, deliveredAt, openedAt, clickedAt, repliedAt, bouncedAt). Filter by status, channel, nodeId, leadId, or sinceDate. Related tools: brandjet_get_campaigns (campaign overview), brandjet_get_lead_timeline (per-lead activity log).

    • campaignIdstringRequired

      Campaign ID

    • pageintegerOptional

      Page number (default: 1)

    • limitintegerOptional

      Results per page (default: 50, max: 100)

    • statusstringOptional

      Filter by execution step status

      One of: pending, processing, completed, failed, skipped, waiting_follow_acceptance, waiting_connection_acceptance

    • channelstringOptional

      Filter by channel

      One of: email, linkedin, twitter, instagram, whatsapp, telegram, sms

    • nodeIdstringOptional

      Filter by workflow node ID

    • leadIdstringOptional

      Filter by lead ID

    • sinceDatestringOptional

      ISO 8601 date to filter steps scheduled/executed after this date

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_create_mention_to_outreach_workflow

    destructive

    Wire up a complete social-listening-to-outreach pipeline in one call: watch for mentions matching a query, optionally filter by sentiment/intent, and prepare matched authors for human-approved enrollment into an outreach campaign by default. Use approvalMode=auto_enroll_paused_campaign only when the user explicitly wants automatic enrollment into a paused campaign. Examples: create a paused campaign for "founders complaining about Hootsuite" on Reddit/X; wire negative LinkedIn mentions into an existing campaignId with enrichment; dry-run a buying-intent workflow before creating resources.

    • listeningQuerystringRequired

      Mention query or topic to monitor, e.g. "founders complaining about Hootsuite".

    • platformsstring[]Optional

      Platform filters. "x" maps to twitter. Hacker News is accepted for intent but currently reported as unsupported until connected. Defaults to all enabled brand platforms.

      One of: twitter, x, reddit, youtube, news, linkedin, tiktok, hacker_news

    • filtersobjectOptional

      Optional sentiment and intent filters.

    • filters.sentimentTypesstring[]Optional

      Only trigger for these sentiment labels.

      One of: positive, negative, neutral, mixed

    • filters.intentTypesstring[]Optional

      Only trigger for these mention intent labels.

      One of: buyer, buying_signal, switching, pain_point, seller, neutral, general_discussion, self_promotion

    • filters.buyerIntentOnlybooleanOptional

      Shortcut for buyer, buying_signal, switching, and pain_point intents.

    • filters.onlyNeedsResponsebooleanOptional

      When true, fetched mentions must still be marked needs_response before enrollment.

    • campaignIdstringOptional

      Existing campaign ID to enroll matched mention authors into. Mutually exclusive with campaign.

    • campaignobjectOptional

      Inline campaign spec to create and wire. Mutually exclusive with campaignId.

    • campaign.namestringRequired

      Campaign name to create.

    • campaign.descriptionstringOptional

      Optional campaign description.

    • campaign.typestringOptional

      Campaign type. Defaults to outreach.

      One of: email_sequence, outreach, nurture, sales

    • campaign.prioritystringOptional

      Campaign priority. Defaults to medium.

      One of: low, medium, high, urgent

    • campaign.targetAudiencestringOptional

      Target audience description.

    • campaign.subjectstringOptional

      Default email subject when sequence is omitted.

    • campaign.messageTemplatestringOptional

      Default first-step message when sequence is omitted.

    • campaign.channelstringOptional

      Default outreach channel for generated sequence. Defaults to email.

      One of: email, linkedin, twitter, instagram, whatsapp, telegram

    • campaign.sequenceobject[]Optional

      Optional sequence steps. If omitted, one step is generated from messageTemplate.

    • campaign.sequence[].channelstringOptional

      Outbound channel for this step. Defaults to the campaign channel.

      One of: email, linkedin, twitter, instagram, whatsapp, telegram

    • campaign.sequence[].subjectstringOptional

      Email subject for email steps.

    • campaign.sequence[].messageTemplatestringRequired

      Message copy. Mention variables are available as {{custom.mention_content}}, {{custom.mention_platform}}, and {{custom.mention_url}}.

    • campaign.sequence[].delayValueintegerOptional

      Delay before this step. Omit for the first immediate step.

    • campaign.sequence[].delayUnitstringOptional

      Delay unit for delayValue.

      One of: minutes, hours, days, weeks

    • campaign.sendingAccountsobjectOptional

      Sending accounts to link to the new campaign.

    • campaign.sendingAccounts.accountIdsstring[]Optional

      Specific email account or integration IDs to link.

    • campaign.sendingAccounts.selectAllbooleanOptional

      When true, link every healthy account matching type/provider.

    • campaign.sendingAccounts.typestringOptional

      Filter for selectAll.

      One of: email, social

    • campaign.sendingAccounts.providerstringOptional

      Provider filter for selectAll.

      One of: google, outlook, smtp, twitter, linkedin, instagram, whatsapp, reddit, youtube, telegram

    • campaign.sendingAccounts.replacebooleanOptional

      Replace existing sending accounts. Defaults to true.

    • campaign.scheduleobjectOptional

      Optional sending schedule.

    • campaign.schedule.timezonestringOptional

      IANA timezone, e.g. America/New_York.

    • campaign.schedule.sendingDaysstring[]Optional

      Days allowed for sending.

      One of: monday, tuesday, wednesday, thursday, friday, saturday, sunday

    • campaign.schedule.sendingTimeStartstringOptional

      Daily sending window start, HH:MM.

    • campaign.schedule.sendingTimeEndstringOptional

      Daily sending window end, HH:MM.

    • campaign.schedule.maxNewLeadsPerDayintegerOptional

      Maximum new leads to contact per day.

    • campaign.initialStatusstringOptional

      Initial campaign state after creation. Defaults to paused for review.

      One of: draft, paused

    • approvalModestringOptional

      Controls whether matched mention authors pause for approval before enrollment. Defaults to require_approval. Use auto_enroll_paused_campaign only when the user explicitly wants automatic enrollment into the paused campaign.

      One of: require_approval, auto_enroll_paused_campaign

    • enrichAuthorsbooleanOptional

      When true, run lead enrichment after each matched author is enrolled. Defaults to false.

    • dryRunbooleanOptional

      When true, validate and return the planned resources without creating anything. Defaults to false.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_conversations

    read only
    idempotent

    Get conversations for the current brand. Without conversationId: lists conversations with rich filtering (channel, status, search, pinned, starred, unread, time range, priority, tags, etc.). To count conversations that received an inbound reply during a calendar range, use countOnly with inboundDateFrom and inboundDateTo; these bounds filter actual inbound message sent time rather than last conversation activity. With conversationId: returns full conversation details including lead, campaign, tags, and participants. Use includeStats to get inbox statistics. Related tools: brandjet_get_messages (view full message thread for a conversation), brandjet_manage_automations (configure inbox automation rules), brandjet_get_team_members (resolve assignedToUserId to a readable name/email).

    • conversationIdstringOptional

      Conversation ID. If provided, returns full details including lead, campaign, tags, and participants. If omitted, lists conversations with filters.

    • includeStatsbooleanOptional

      Include inbox statistics (total, active, closed, unread counts, counts by channel and tag). Only applies when listing conversations. Default: false.

    • countOnlybooleanOptional

      Return only the exact number of matching conversations. Use with inboundDateFrom and inboundDateTo to count conversations that received an inbound reply in that range.

    • channelstringOptional

      Filter by communication channel

      One of: email, linkedin, twitter, instagram, whatsapp, slack, sms

    • statusstringOptional

      Filter by conversation status

      One of: active, closed, snoozed, spam

    • searchstringOptional

      Search in conversation subject, last message text, lead name and email, and participant names and emails. Participants include people who replied on a campaign thread from an address other than the lead email.

    • isPinnedbooleanOptional

      Filter for pinned conversations only

    • isStarredbooleanOptional

      Filter for starred conversations only

    • isArchivedbooleanOptional

      Filter for archived conversations. Default shows non-archived.

    • hasUnreadbooleanOptional

      Filter for conversations with unread messages

    • isUnassignedbooleanOptional

      Filter for unassigned conversations

    • hasNoReplybooleanOptional

      Filter for conversations where the brand has not replied

    • noInboundReplybooleanOptional

      Filter for outbound-only conversations (no inbound messages)

    • hasInboundReplybooleanOptional

      Filter for conversations that have at least one inbound reply. A message from another address counts when it answers a message in the thread, unless it is an automatic reply or a delivery notice.

    • timeFilterstringOptional

      Time-based filter. "last_*" filters by last message time, "no_reply_*" filters by time since last reply.

      One of: last_24_hours, last_3_days, last_7_days, last_30_days, no_reply_in_24h, no_reply_in_3_days, no_reply_in_7_days, older_than_30_days

    • inboundDateFromstringOptional

      Inclusive lower bound for actual inbound message sent time. Must be an ISO 8601 timestamp with a UTC designator or numeric offset.

    • inboundDateTostringOptional

      Exclusive upper bound for actual inbound message sent time. Must be an ISO 8601 timestamp with a UTC designator or numeric offset.

    • prioritystringOptional

      Filter by priority level

      One of: high, medium, low

    • tagNamestringOptional

      Filter by tag name (ordinary labels)

    • assignedToUserIdstringOptional

      Filter by assigned user ID

    • leadIdstringOptional

      Filter by lead ID

    • crmStageIdsstring[]Optional

      Pipeline stages, OR with no stage and not in CRM

    • hasNoCrmStagebooleanOptional

      Linked contacts without a pipeline stage

    • hasNoLeadbooleanOptional

      Conversations not linked to CRM

    • campaignIdstringOptional

      Filter by campaign ID

    • pageintegerOptional

      Page number for pagination (default: 1)

    • limitintegerOptional

      Items per page (default: 50, max: 100)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_update_conversation

    destructive

    Update a conversation: change status, pin/unpin, star/unstar, archive, assign to a user, change priority, or mark as read. Use action="archive" to archive, action="mark_read" to mark as read, or action="update" (default) to change fields.

    • conversationIdstringRequired

      Conversation ID to update

    • actionstringOptional

      Special action. "archive" archives the conversation. "mark_read" marks it and all messages as read. "update" (default) applies field updates.

      One of: update, archive, mark_read

    • crmStageIdstring | nullOptional

      Pipeline stage of the linked contact

    • expectedVersionintegerOptional

      Current linked contact stageVersion, required for stage changes

    • reopenConfirmedbooleanOptional
    • subjectstringOptional

      Update the conversation subject

    • statusstringOptional

      Change conversation status

      One of: active, closed, snoozed, spam

    • isPinnedbooleanOptional

      Pin or unpin the conversation

    • isStarredbooleanOptional

      Star or unstar the conversation

    • isArchivedbooleanOptional

      Archive or unarchive the conversation

    • assignedToUserIdstringOptional

      Assign the conversation to a user by their user ID

    • prioritystringOptional

      Set the conversation priority

      One of: high, medium, low

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_messages

    read only
    idempotent

    Get messages within a specific conversation (paginated, oldest first). Without conversationId, returns only the unread message count for the brand. Do NOT use to list conversations (use brandjet_get_conversations).

    • conversationIdstringOptional

      Conversation ID to get messages for. If omitted, returns the unread message count for the current brand.

    • campaignIdstringOptional

      Restrict messages to conversations belonging to this campaign

    • pageintegerOptional

      Page number (default: 1). Messages are ordered oldest-first.

    • limitintegerOptional

      Messages per page (default: 50, max: 100)

    • includeHtmlbooleanOptional

      Also return htmlContent, the original HTML body of each message (null for non-email channels). Default false.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_send_message

    destructive

    Send a reply message in an existing conversation. Supports email, LinkedIn, Twitter, Instagram, and WhatsApp. The message is routed through the appropriate channel integration based on the conversation channel. Pass draftId to send a reply draft, for example one saved by an auto_reply rule in draft mode. Email replies are rejected when the lead or any CC or BCC address is suppressed; brandjet_get_suppression_status checks addresses ahead of time.

    • conversationIdstringRequired

      Conversation ID to send the message in

    • contentstringOptional

      Message content (plain text). For email, this is the text version. Required unless draftId is given or, for email, htmlContent is given.

    • htmlContentstringOptional

      HTML content for email messages. If provided, used as the email body.

    • draftIdstringOptional

      Send a reply draft from this conversation, such as one an auto_reply rule saved in draft mode (see get_logs). Its text is used unless content is given, and the draft is removed once sent.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_conversation_tags

    Add or remove tags on a conversation. Tags label conversations (e.g., "support", "urgent"). Use action="add" with tagName, or action="remove" with tagId. Adding a tag runs enabled auto_reply rules that have runOnTagAdded and that tag as tagMatch. Adding a tag the conversation already has does nothing, so remove it first to run those rules again.

    • conversationIdstringRequired

      Conversation ID

    • actionstringRequired

      Whether to add or remove a tag

      One of: add, remove

    • tagNamestringOptional

      Tag name to add (required when action is "add")

    • tagColorstringOptional

      Hex color for the tag (e.g., "#FF5733"). Only used when adding.

    • tagIdstringOptional

      Tag ID to remove (required when action is "remove"). Get tag IDs from brandjet_get_conversations.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_custom_views

    destructive

    Manage custom inbox views for the current brand. Views are saved filter configurations. Actions: "list" (get all views including predefined), "create" (save a new view with filters), "update" (modify existing view), "delete" (remove a view).

    • actionstringRequired

      Action to perform on custom views

      One of: list, create, update, delete

    • viewIdstringOptional

      View ID (required for "update" and "delete" actions)

    • namestringOptional

      View name (required for "create")

    • descriptionstringOptional

      View description

    • emojistringOptional

      Emoji icon for the view

    • sortOrderintegerOptional

      Display order among views

    • filtersobjectOptional

      Filter configuration as JSON. Supports keys: status, channel, timeFilter, priority, hasUnread, isUnassigned, hasNoReply, isPinned, isStarred, tagName, search.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_automations

    destructive

    Manage inbox automation rules. "list" returns all rules (optionally filtered by type) with their runs and failures over the last 7 days. "get" returns a single rule with the same stats. "create" creates a new rule. "update" updates fields. "toggle" enables/disables. "delete" removes a rule. "get_logs" returns execution audit logs. Rule types: auto_assign (round-robin assignment, optionally with a follow up task for the assignee through createTask, taskTitle and taskDueInMinutes), auto_reply (template or AI reply). The assignee is notified when a rule assigns a conversation, and brand owners and admins are alerted once a day when a rule fails. Pipeline progression is configured in the pipeline settings. auto_reply runs when a new inbound message arrives on a cold-inbox conversation that matches the rule label, channel, pipeline stage, reply intent and campaignIds after that message is classified. With runOnTagAdded it also runs when its tagMatch label is added to a single conversation (not in bulk). maxRepliesPerConversation limits how many auto-replies one conversation gets, and draftOnly saves replies as Unibox drafts instead of sending them. Each time a matching auto_reply rule runs, its outcome and reason are logged in get_logs. Related tools: brandjet_get_conversations (view conversations that trigger rules).

    • actionstringRequired

      Action to perform on inbox automation rules. "list" returns all rules. "get" returns a single rule. "create" creates a new rule. "update" updates an existing rule. "toggle" enables/disables a rule. "delete" deletes a rule and preserves its historical logs. "get_logs" returns one row per auto_reply outcome (success, skipped, deduped or failed) with skippedReason or errorMessage. Rows with action "auto_reply_draft" were saved as drafts and include the draft when it still exists.

      One of: list, get, create, update, toggle, delete, get_logs

    • ruleIdstringOptional

      Rule ID (required for get, update, toggle, delete; optional filter for get_logs)

    • typestringOptional

      Rule type. Required for create. Used as filter for list. "auto_assign" round-robins assignment. "auto_reply" sends template or AI reply.

      One of: auto_assign, auto_reply

    • namestringOptional

      Rule name (required for create)

    • crmStageIdsstring[] | nullOptional
    • replyIntentMatchstring | nullOptional
    • tagMatchstringOptional

      Only fire when the conversation has this tag (case-insensitive). Checked once per new inbound message, after that message has been auto-tagged. With runOnTagAdded, adding this tag to a conversation also runs the rule. Omit to match every conversation.

    • campaignIdsstring[] | nullOptional

      Only fire for conversations that belong to one of these campaigns. Pass null or an empty array to match every campaign.

    • campaignIdstringOptional

      Shorthand for campaignIds with a single campaign.

    • maxRepliesPerConversationinteger | nullOptional

      auto_reply only. Stop auto-replying in a conversation once it has received this many auto-replies from any rule. 1 means reply once. null removes the limit.

    • draftOnlybooleanOptional

      auto_reply only. Save each reply as a Unibox draft for the conversation assignee (or the brand owner when unassigned) instead of sending it. get_logs shows these rows with action "auto_reply_draft" and the draft. The draft owner can send it with brandjet_send_message and draftId.

    • runOnTagAddedbooleanOptional

      auto_reply only. Also run this rule when its tagMatch tag is added to a single conversation, either in the conversation view or with brandjet_manage_conversation_tags. Tags added in bulk do not run it. It answers the latest inbound message unless that message was already answered. Requires tagMatch.

    • createTaskbooleanOptional

      auto_assign only. Also create a task for the new assignee, linked to the conversation. The assignee gets one notification naming the rule and the task. Requires taskTitle.

    • taskTitlestring | nullOptional

      auto_assign only. Title of the task the rule creates, like "Follow up". An open task with the same title on the conversation is not duplicated.

    • taskDueInMinutesinteger | nullOptional

      auto_assign only. When the created task is due, in minutes after the assignment (1440 is one day). null means no due date.

    • channelMatchstringOptional

      Only fire for this channel (null = any channel)

      One of: email, linkedin, twitter, instagram, whatsapp, slack, sms

    • isEnabledbooleanOptional

      Whether the rule is active. Required for toggle.

    • assignToUserIdsstring[]Optional

      User IDs for round-robin assignment (auto_assign rules)

    • replyModestringOptional

      Reply mode: "template" for fixed text, "ai" for AI-generated (auto_reply rules)

      One of: template, ai

    • templateContentstringOptional

      Template content when replyMode is "template"

    • aiPromptstringOptional

      AI instructions when replyMode is "ai". Besides these instructions the AI receives: brand name and description; the last 20 messages; lead name and first name; company; lead custom variables (contact, secret and internal data such as email, phone, address or qualification_status are left out); campaign name and ID; conversation tags; the rule tagMatch; and the latest inbound sender display name. On email the sender display name is never used as the lead name. Missing values are given as NONE and the AI is told not to guess them. Refer to these facts in plain words (e.g. "if the region custom variable is far-east"); {{placeholders}} are not substituted.

    • delayMinutesintegerOptional

      Delay in minutes before an auto_reply is sent. Only one auto-reply per conversation is pending at a time: inbound messages that arrive while one is pending do not schedule another, and when several auto_reply rules match an inbound message, only the first by sortOrder runs. Once the reply is sent, the next inbound message gets its own reply. A reply is skipped if the latest inbound message was already answered, and each conversation gets at most 10 auto-replies per 24 hours.

    • sortOrderintegerOptional

      Display order among rules

    • conversationIdstringOptional

      Filter logs by conversation (get_logs only)

    • sincestringOptional

      ISO 8601 date to filter logs since (get_logs only)

    • limitintegerOptional

      Max logs to return (get_logs only, default: 50)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_tasks

    destructive

    Manage Unibox tasks: the follow ups a team tracks next to its conversations. Tasks have a title, notes, status (todo, in_progress, done), an assignee, a team, a due date, an optional linked conversation and one level of subtasks. You only see tasks whose linked conversation you can open. Assigning a task notifies the assignee, and due and overdue reminders go out on their own. Use "summary" for a quick count, "list" to browse, and "create" with conversationId to add a follow up to a reply. Related tools: brandjet_get_conversations (find a conversationId), brandjet_get_team_members (resolve user IDs), brandjet_manage_teams (team IDs).

    • actionstringRequired

      Action on Unibox tasks. "list" returns tasks you can see, soonest due first. "get" returns one task with its subtasks. "summary" returns open task counts: assigned to you, created by you, all, unassigned and your overdue ones. "create" adds a task, linked to a conversation or as a subtask when given. "update" changes any field. "complete" marks a task done and "reopen" moves it back to to do. "delete" removes a task and its subtasks; only its creator or a brand admin can delete it.

      One of: list, get, summary, create, update, complete, reopen, delete

    • taskIdstringOptional

      Task ID. Required for get, update, complete, reopen and delete.

    • viewstringOptional

      List only. "mine" is tasks assigned to you, "created" is tasks you created, "all" is every task you can see. Defaults to "mine", or to "all" when assigneeUserIds, unassigned, teamIds or conversationId is given.

      One of: mine, created, all

    • statusesstring[]Optional

      List only. Statuses to include. Defaults to open tasks (todo and in_progress), or every status when searching.

      One of: todo, in_progress, done

    • assigneeUserIdsstring[]Optional

      List only. Tasks assigned to these users. Resolve names with brandjet_get_team_members.

    • unassignedbooleanOptional

      List only. Include tasks with no assignee.

    • teamIdsstring[]Optional

      List only. Tasks set to these teams. Get team IDs from brandjet_manage_teams.

    • conversationIdstring | nullOptional

      List: tasks linked to this conversation. Create and update: link the task to this conversation, or null on update to unlink it. Subtasks always follow the conversation of their parent.

    • overduebooleanOptional

      List only. Only open tasks whose due date has passed.

    • noDueDatebooleanOptional

      List only. Only tasks without a due date.

    • dueAfterstringOptional

      List only. Tasks due at or after this time.

    • dueBeforestringOptional

      List only. Tasks due at or before this time.

    • searchstringOptional

      List only. Match words in task titles.

    • includeSubtasksbooleanOptional

      List only. Also return subtasks that have the same assignee as their parent. The app hides them under the parent, and so does this tool by default.

    • sortstringOptional

      List only. "due" (default) is soonest due first, "newest" is newest first, "updated" is most recently changed first.

      One of: due, newest, updated

    • limitintegerOptional

      List only. Max tasks to return (default 50).

    • offsetintegerOptional

      List only. Number of tasks to skip, for paging.

    • titlestringOptional

      Task title. Required for create.

    • descriptionstring | nullOptional

      Task notes in plain text, or null to clear.

    • statusstringOptional

      Create and update. Task status.

      One of: todo, in_progress, done

    • assigneeUserIdstring | nullOptional

      Who does the task. On create it defaults to you; pass null to leave it unassigned. On update pass a user ID to reassign or null to unassign. The assignee must be able to open the linked conversation.

    • teamIdstring | nullOptional

      Team for the task, or null to clear. On create it defaults to the assignee's team when they are in exactly one team.

    • dueAtstring | nullOptional

      Due date and time in ISO 8601 with offset, or null to clear. For a day with no time, set dueAllDay to true and pass 23:59:59 of that day in the user's timezone, for example 2026-10-24T23:59:59+05:00.

    • dueAllDaybooleanOptional

      True when the task is due on a day rather than at a time.

    • parentTaskIdstringOptional

      Create only. Make the new task a subtask of this task. Subtasks cannot have their own subtasks.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_teams

    destructive

    Manage teams in the current brand. Teams group teammates, like Sales or Support, so tasks can be assigned, filtered and grouped by team. Anyone in the brand can list teams; creating, renaming, changing members and deleting need a brand owner or admin. People added to a team are notified. Related tools: brandjet_get_team_members (resolve user IDs), brandjet_manage_tasks (tasks by team).

    • actionstringRequired

      Action on teams, which group teammates so tasks can be assigned, filtered and grouped by team (like Sales or Support). "list" returns teams and their members. "create", "update" and "delete" need a brand owner or admin. Deleting a team keeps its tasks and only clears their team.

      One of: list, create, update, delete

    • teamIdstringOptional

      Team ID. Required for update and delete.

    • namestringOptional

      Team name, unique within the brand. Required for create.

    • memberUserIdsstring[]Optional

      Create: the first members. Update: replaces the whole member list. Members must belong to the brand; resolve them with brandjet_get_team_members.

    • addMemberUserIdsstring[]Optional

      Update only. Add these members and keep the others.

    • removeMemberUserIdsstring[]Optional

      Update only. Remove these members and keep the others.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_snippets

    destructive

    Manage snippets: saved replies teammates insert by typing / in a Unibox reply, with variables that fill in per contact. Use them to keep answers consistent, like pricing, booking a call or a gentle follow up. Related tools: brandjet_send_message (send a reply), brandjet_manage_automations (rules that reply on their own).

    • actionstringRequired

      Action on snippets, the saved replies teammates insert by typing / in a Unibox reply. "list" returns the brand's snippets. "get" returns one. "create", "update" and "delete" change them. Names are unique within the brand.

      One of: list, get, create, update, delete

    • snippetIdstringOptional

      Snippet ID. Required for get, update and delete.

    • searchstringOptional

      List only. Match snippet names.

    • namestringOptional

      Snippet name. Required for create.

    • contentstringOptional

      Snippet text. Required for create. These variables fill in per contact when the snippet is inserted: {{first_name}}, {{last_name}}, {{company_name}}, {{job_title}}, {{email}}, {{phone}}, {{sender_name}} and {{sender_email}}.

    • categorystring | nullOptional

      List: only this category. Create and update: group the snippet under this category, or null to clear it.

    • channelstring | nullOptional

      List: snippets for this channel, including those for every channel. Create and update: limit the snippet to one channel, or null for every channel.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_send_outreach_message

    destructive

    Send a brand-new outbound message to one or more existing leads across email, LinkedIn, Twitter, Instagram, or WhatsApp. Creates a fresh Unibox conversation per lead. Always call once with confirmed=false first to get a preview (sender account, per-lead recipient + blockers, schedule), show it to the user, then re-call with confirmed=true to actually send. Bulk sends (leadIds.length > 1) are queued with a per-channel default spread so they trickle out gradually. Requires unibox:write scope. Distinct from brandjet_send_message, which replies inside an existing conversation.

    • idempotencyKeystringOptional

      Stable request key to reuse when retrying the same outreach request. Use a new key for a deliberate new message.

    • channelstringRequired

      Channel to send on. Each channel requires the lead to have the matching identifier (email for email; linkedinMetadata.providerId for LinkedIn; instagramMetadata.providerId for Instagram; whatsappMetadata.providerId or phoneNumber for WhatsApp; twitterMetadata.twitterUserId or twitterProfileUrl for Twitter).

      One of: email, linkedin, twitter, instagram, whatsapp

    • leadIdsstring[]Required

      Lead IDs to message (1-50). Use brandjet_get_leads or brandjet_advanced_filter_leads to find them. Each lead must already exist in this brand.

    • contentstringRequired

      Plain-text message body. For email this is the text version (or the body when htmlContent is not provided).

    • htmlContentstringOptional

      Optional HTML body. Email only. When provided it is used as the email body and sanitized for tracking pixels.

    • subjectstringOptional

      Email subject line. Email only. If omitted, a default outreach subject is generated.

    • emailAccountIdstringOptional

      Optional email account ID to send from. Email only. If omitted, the first connected email account for the brand is used.

    • integrationIdstringOptional

      Exact integration ID to send from for LinkedIn, Instagram, WhatsApp, and Twitter. Always provide it for new calls. Omission is supported only for backward compatibility and may select the legacy default account.

    • spreadSecondsintegerOptional

      Seconds between each send when leadIds.length > 1. Defaults: email 60s, LinkedIn 300s, Twitter/Instagram/WhatsApp 180s. Use higher values for caution.

    • confirmedbooleanOptional

      Must be true to actually send. When false or omitted, returns a dry-run preview only (sender account, per-lead eligibility, schedule). Always preview first, then resend with confirmed=true after the user approves.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_proposals

    read only
    idempotent

    List proposals for the current brand with their signing status (draft, sent, viewed, signed, declined) and tracked deal value. Filter by lead, campaign, or status. Use this to answer "did they sign?", to find a proposal to send, or to report signed value. Requires proposals:read scope.

    • leadIdstringOptional

      Filter proposals for one lead.

    • campaignIdstringOptional

      Filter proposals attributed to one campaign.

    • statusstringOptional

      Filter by proposal status.

      One of: draft, sent, viewed, signed, declined, expired, voided

    • pageintegerOptional

      Page number, default 1.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_create_proposal

    Create a signable proposal draft for a lead. The content is generated from a semantic spec (scope summary + deliverables + optional pricing) and autofilled with the lead's name, email, company, and title. Returns the draft with its id — it is NOT sent yet; follow up with brandjet_send_proposal. Requires proposals:write scope.

    • leadIdstringRequired

      The lead the proposal is for. The lead must have an email address.

    • conversationIdstringOptional

      Optional Unibox conversation to attribute the proposal to. Improves campaign attribution and signed-value tracking.

    • titlestringOptional

      Proposal title. Defaults to "Proposal for <lead name>".

    • scopeSummarystringRequired

      What the proposal is for, in plain language (20-500 chars). Semantic purpose only — no formatting instructions.

    • deliverablesstring[]Required

      The concrete deliverables, one string each (1-12).

    • priceAmountnumberOptional

      Price shown in the proposal, USD. Also becomes the tracked deal value unless valueAmount is set.

    • valueAmountnumberOptional

      Tracked deal value in USD when different from the price.

    • timelinestringOptional

      Optional timeline text.

    • termsstringOptional

      Optional terms text.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_send_proposal

    destructive

    Send a drafted proposal to its lead. When the lead has an existing email conversation, the proposal email goes out from the connected mailbox as a reply in that thread (deliveredVia: conversation); otherwise it is emailed directly (deliveredVia: email). The lead signs on a secure signing page and signing is tracked back into BrandJet. Always call once without confirmed to get a preview (recipient, subject, body, delivery route), show it to the user, then call again with confirmed: true to actually send. Requires proposals:write scope.

    • proposalIdstringRequired

      The proposal to send, from brandjet_get_proposals or brandjet_create_proposal.

    • subjectstringOptional

      Email subject. Placeholders like {document_title} and {client_company} are rendered at delivery. Defaults to a sensible subject.

    • bodyHtmlstringOptional

      Email body HTML. Placeholders like {client_first_name}, {document_url}, and {sender_name} are rendered at delivery. Defaults to a short delivery note.

    • confirmedbooleanOptional

      Must be true to actually send. Call once without it to get a preview of what will be sent, show the user, then call again with confirmed: true.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_proposal

    read only
    idempotent

    Load one proposal in full: content sections, variables, signing status, deal value and outcome, plus engagement analytics (views, unique viewers, time on page, PDF downloads, reminders). Use this to answer "did they open it?" or before reminding or voiding. Requires proposals:read scope.

    • proposalIdstringRequired

      The proposal to load, from brandjet_get_proposals.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_remind_proposal

    destructive

    Send a signing reminder for a proposal that is sent or viewed but not yet signed. Goes out in the original email thread when there is one, otherwise as a branded email. Reminders are rate-limited to one per hour per proposal. Call once without confirmed to check status and last reminder, then again with confirmed: true. Requires proposals:write scope.

    • proposalIdstringRequired

      The proposal awaiting signature to nudge.

    • confirmedbooleanOptional

      Must be true to actually send the reminder. Without it, the proposal status and last reminder time are returned for the user to confirm.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_void_proposal

    destructive

    Withdraw a sent proposal so its signing link stops working. The lead is emailed that it was withdrawn (with your optional reason). Drafts cannot be voided — delete them instead. Call once without confirmed to show the proposal, then again with confirmed: true. Requires proposals:write scope.

    • proposalIdstringRequired

      The sent proposal to withdraw.

    • reasonstringOptional

      Optional reason shared with the lead in the withdrawal email.

    • confirmedbooleanOptional

      Must be true to actually void. Without it, the proposal is returned for the user to confirm.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_update_proposal_outcome

    Record the business outcome of a proposal (won, lost, ghosted, or back to pending) with an optional reason. This is separate from the signing status and feeds win-rate reporting. Requires proposals:write scope.

    • proposalIdstringRequired

      The proposal to update.

    • outcomestringRequired

      Business outcome, independent of signing status. Signed proposals default to won and declined ones to lost.

      One of: pending, won, lost, ghosted

    • reasonstringOptional

      Why the deal was won, lost, or went quiet.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_send_booking_link

    destructive

    Mint a tracked booking link for a lead and optionally send it into their Unibox conversation. The link opens the acting user's booking page with the lead's details prefilled; when the lead books, the meeting is attributed back to the lead and campaign automatically. Call once without confirmed to preview the link and message; with confirmed: true and a conversationId the message is sent in the conversation. Requires meetings:write scope.

    • conversationIdstringOptional

      The Unibox conversation to send the booking link in. Either this or leadId is required.

    • leadIdstringOptional

      The lead to mint the booking link for when there is no conversation. The link is returned for you to deliver.

    • messagestringOptional

      Message text to send with the link. Defaults to a short suggested message containing the link.

    • confirmedbooleanOptional

      Must be true to actually send the message into the conversation. Without it, the minted link and suggested message are returned as a preview.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_meetings

    read only
    idempotent

    List meetings for the current brand — booked by leads through booking links or added manually — with times, guests, status, and cancellation details. Requires meetings:read scope.

    • leadIdstringOptional

      Filter meetings for one lead.

    • upcomingbooleanOptional

      Only meetings that start in the future, soonest first.

    • statusstringOptional

      Filter by status. Omit with upcoming: true to get confirmed meetings only.

      One of: confirmed, cancelled

    • pageintegerOptional

      Page number, default 1.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_cancel_meeting

    destructive

    Cancel one of the acting user's upcoming meetings. The guest gets a cancellation email (with your optional note) and a link to pick a new time. Always call once without confirmed to show the meeting to the user, then call again with confirmed: true. Requires meetings:write scope.

    • meetingIdstringRequired

      The meeting to cancel, from brandjet_get_meetings.

    • reasonstringOptional

      Optional note shown to the guest in the cancellation email.

    • confirmedbooleanOptional

      Must be true to actually cancel. Without it, the meeting details are returned for the user to confirm.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_create_meeting

    destructive

    Add a meeting the user already scheduled with someone (for example agreed over the phone) so it appears on their BrandJet calendar, blocks the slot on their booking page, and is attributed to the lead. Optionally emails the guest a confirmation with a calendar invite. Requires meetings:write scope.

    • leadIdstringOptional

      Lead to attribute the meeting to, when known.

    • guestNamestringRequired

      Guest full name.

    • guestEmailstringRequired

      Guest email address.

    • guestCompanystringOptional

      Guest company.

    • titlestringOptional

      Meeting title.

    • startsAtstringRequired

      Meeting start as an ISO 8601 timestamp with timezone offset, e.g. 2026-09-15T14:00:00Z.

    • durationMinutesintegerOptional

      Length in minutes. Defaults to the calendar default duration.

    • notesstringOptional

      Agenda or notes for the meeting. Shared with the guest in the confirmation email and calendar invite.

    • sendInvitebooleanOptional

      Email the guest a confirmation with a calendar invite. Defaults to true.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_availability

    read only
    idempotent

    Read the acting user's booking calendar: whether bookings are on, the public booking URL, timezone, meeting length, buffers, notice, weekly hours, and date overrides. Use this before promising a lead a meeting time or to explain why a booking link is off. Requires meetings:read scope.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_lead_lists

    read only
    idempotent

    Get lead lists for the current brand. Without leadListId: lists all lead lists with pagination and search. With leadListId: returns full details for that list. Optionally include shared pipeline stages and management statistics.

    • leadListIdstringOptional

      Lead list ID. If provided, returns full details for that list. If omitted, lists all lead lists for the current brand.

    • searchstringOptional

      Search lead lists by name

    • pageintegerOptional

      Page number (default: 1)

    • limitintegerOptional

      Items per page (default: 50, max: 100)

    • includeStagesbooleanOptional

      Include shared pipeline stage definitions for the brand (default: false)

    • includeStatsbooleanOptional

      Include lead management statistics — total leads, verified, unverified, lists count (default: false)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_leads

    read only
    idempotent

    Get leads already in the brand's lead lists. With leadId: returns full details. With leadListId: returns leads in that list. Without either: returns all brand leads. List and detail responses include jobTitle, company, and linkedinProfileUrl for ICP qualification. For complex multi-condition queries, use brandjet_advanced_filter_leads instead. For CRM pipeline views, use brandjet_manage_crm_leads. Do NOT use to search external lead databases (use brandjet_search_lead_database). Use brandjet_get_team_members to resolve assignedTo user IDs into readable names/emails.

    • leadIdstringOptional

      Lead ID. If provided, returns full lead details including pipeline stage, list, and social profiles. Use includeNotes to also fetch notes.

    • leadListIdstringOptional

      Filter leads within a specific lead list. Ignored when leadId is provided.

    • searchstringOptional

      Search leads by name or email

    • crmStageIdstringOptional

      Filter leads by pipeline stage ID

    • verificationStatusstringOptional

      Filter by email verification status

      One of: verified, unverified

    • includeNotesbooleanOptional

      Include lead notes when fetching a single lead by leadId (default: false)

    • includeEnrichmentDatabooleanOptional

      Include enrichment data (enrichmentStatus, lastEnrichedAt, enrichmentData) when fetching a single lead by leadId (default: false)

    • pageintegerOptional

      Page number (default: 1)

    • limitintegerOptional

      Items per page (default: 50, max: 100)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_create_lead

    destructive

    Create a new lead list, or add/correct leads in an existing list. Use action="create_list" with listName to create an empty list. Use action="create_lead" with leadListId and lead details to add one lead. Use action="create_leads" with leadListId and leads[] to create up to 500 leads in one bulk call. Use action="upsert_leads" with leadListId and leads[] to match rows against existing brand leads by LinkedIn URL or email and update them in place, creating only the ones that do not already exist. Every lead requires a real name; never invent placeholder names such as "LinkedIn Profile 1". Always send the whole batch in a single call instead of one call per lead.

    • actionstringRequired

      Action to perform. "create_list" creates a new empty lead list. "create_lead" adds one lead. "create_leads" adds up to 500 leads in one bulk call. "upsert_leads" matches each row against existing brand leads by LinkedIn profile URL or email and updates those in place, creating only the rows that do not match. Use upsert_leads whenever you are correcting or re-importing leads that may already exist (for example replacing names on a list you imported earlier) — never loop brandjet_update_lead one lead at a time.

      One of: create_list, create_lead, create_leads, upsert_leads

    • listNamestringOptional

      Name for the new lead list (required for "create_list")

    • leadListIdstringOptional

      Target lead list ID (required for "create_lead" and "create_leads")

    • namestringOptional

      Lead full name (required for "create_lead"). Must be the real person name, never a placeholder.

    • emailstringOptional

      Lead email address

    • phoneNumberstringOptional

      Lead phone number (E.164 format)

    • linkedinProfileUrlstringOptional

      LinkedIn profile URL

    • twitterProfileUrlstringOptional

      Twitter/X profile URL

    • instagramProfileUrlstringOptional

      Instagram profile URL

    • customVariablesobjectOptional

      Custom personalization variables as key-value pairs (e.g., {"company": "Acme", "role": "CTO"})

    • leadsobject[]Optional

      Lead payloads for "create_leads" and "upsert_leads". Max 500 per call. Send the whole batch in one call, not one lead per call. Example: [{"name":"Ada Lovelace","linkedinProfileUrl":"https://www.linkedin.com/in/ada"},{"name":"Alan Turing","email":"alan@example.com"}]

    • leads[].namestringRequired

      Lead full name. REQUIRED for every lead — the import is rejected if any row is missing it. Never substitute a placeholder such as "LinkedIn Profile 1" or "Unknown": BrandJet cannot derive a real name from a LinkedIn URL later, so a placeholder becomes permanent. If the source data has no name, stop and ask the user for one.

    • leads[].emailstringOptional

      Lead email address

    • leads[].phoneNumberstringOptional

      Lead phone number (E.164 format)

    • leads[].linkedinProfileUrlstringOptional

      LinkedIn profile URL

    • leads[].twitterProfileUrlstringOptional

      Twitter/X profile URL

    • leads[].instagramProfileUrlstringOptional

      Instagram profile URL

    • leads[].customVariablesobjectOptional

      Custom personalization variables as key-value pairs

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_update_lead

    destructive

    Update a single lead: modify fields or pipeline stage, add/delete notes, or delete the lead. For updating multiple leads at once, use brandjet_bulk_lead_operations instead.

    • expectedVersionintegerOptional

      Last observed stage version; reject a concurrent stage change.

    • reopenConfirmedbooleanOptional

      Explicitly confirm moving out of a Won or Lost stage.

    • leadIdstringRequired

      Lead ID to update

    • actionstringOptional

      Action to perform. "update" (default) modifies lead fields and/or pipeline stage. "add_note" adds a note. "delete_note" removes a note. "delete" deletes the lead.

      One of: update, add_note, delete_note, delete

    • namestringOptional

      Updated lead name (action: update)

    • emailstringOptional

      Updated email address (action: update)

    • phoneNumberstringOptional

      Updated phone number (action: update)

    • linkedinProfileUrlstringOptional

      Updated LinkedIn URL (action: update)

    • twitterProfileUrlstringOptional

      Updated Twitter URL (action: update)

    • instagramProfileUrlstringOptional

      Updated Instagram URL (action: update)

    • customVariablesobjectOptional

      Updated custom variables (action: update)

    • crmStageIdstring | nullOptional

      Set the shared pipeline stage. Null clears it. Use brandjet_manage_crm_stages to list stages. (action: update)

    • noteContentstringOptional

      Note text to add (required for action: add_note)

    • noteIdstringOptional

      Note ID to delete (required for action: delete_note). Get note IDs from brandjet_get_leads with includeNotes.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_lead_lists

    destructive

    Manage lead lists: update_list (rename), delete_list, merge_lists (combine several lists into one, deduplicating leads). Manage shared pipeline stages with brandjet_manage_crm_stages.

    • actionstringRequired

      Manage lead lists: update_list, delete_list, or merge_lists. Pipeline stages are managed with brandjet_manage_crm_stages.

      One of: update_list, delete_list, merge_lists

    • leadListIdstringOptional

      Lead list ID (required for update_list, delete_list)

    • namestringOptional

      New name for the lead list (action: update_list)

    • listIdsstring[]Optional

      Lead list IDs to merge (required for merge_lists, at least 2). Every lead moves into the destination, cross-list duplicates are combined into one record, and the emptied lists are deleted.

    • targetListIdstringOptional

      Existing list that receives the leads (action: merge_lists). Usually one of listIds. Provide this or newListName.

    • newListNamestringOptional

      Create a new list with this name as the merge destination (action: merge_lists). Provide this or targetListId.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_lead_stats

    read only
    idempotent

    Get lead analytics and statistics for the current brand. Always returns management stats (total leads, lead lists, verified, unverified). Optionally include verified/unverified distribution, pipeline stage counts, and lead list summaries.

    • includeDistributionbooleanOptional

      Include verified vs unverified lead distribution (default: false)

    • includeStageStatsbooleanOptional

      Include lead count per shared pipeline stage (default: false)

    • includeListSummarybooleanOptional

      Include summary of all lead lists with counts (default: false)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_lead_collections

    Manage automated lead scraping collections. "list" shows all collections. "status" checks progress. "create_linkedin" starts scraping from LinkedIn search. "create_instagram" starts scraping from an Instagram username or post. "pause/resume/retry/delete" control existing collections.

    • actionstringRequired

      Action to perform. "list" shows all collections. "status" checks a collection's progress. "create_linkedin" starts LinkedIn lead scraping from search. "create_instagram" starts Instagram lead scraping from a username or post. "pause/resume/retry/delete" control existing collections.

      One of: list, status, create_linkedin, create_instagram, pause, resume, retry, delete

    • collectionIdstringOptional

      Collection ID (required for status, pause, resume, retry, delete)

    • searchstringOptional

      Search collections by name (action: list)

    • pageintegerOptional

      Page number (action: list, default: 1)

    • limitintegerOptional

      Items per page (action: list, default: 50)

    • searchQuerystringOptional

      Plain keyword search terms for the LinkedIn scraper (required for create_linkedin). This is NOT a URL: passing a linkedin.com/search or Sales Navigator link is rejected. Examples: "Southfield, Michigan, United States restaurants", "VP of Sales B2B SaaS San Francisco". If the user has an exact search URL, ask them to export it to CSV and import with brandjet_create_lead instead.

    • collectionLimitintegerOptional

      Maximum number of leads to collect (required for create_linkedin and create_instagram)

    • collectionNamestringOptional

      Display name for the collection (action: create_linkedin)

    • usernamestringOptional

      Instagram username to collect followers/following from (action: create_instagram)

    • postLinkstringOptional

      Instagram post URL to collect likes/comments from (action: create_instagram)

    • collectFollowersbooleanOptional

      Collect followers of the username (action: create_instagram)

    • collectFollowingbooleanOptional

      Collect following of the username (action: create_instagram)

    • collectLikesbooleanOptional

      Collect likes on the post (action: create_instagram)

    • collectCommentsbooleanOptional

      Collect comments on the post (action: create_instagram)

    • leadListIdstringOptional

      Target lead list to store collected leads in (action: create_linkedin, create_instagram)

    • isContinuousbooleanOptional

      Run collection continuously with daily limits (action: create_linkedin, create_instagram, default: false)

    • autoVerifybooleanOptional

      Automatically verify collected email addresses (action: create_linkedin, create_instagram, default: false)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_crm_stages

    destructive

    Manage CRM pipeline stages for the current brand. "list" returns all stages with name, color, and position. "create" adds a new stage. "update" modifies a stage's name or color. "delete" removes a stage. "reorder" sets the display order by providing an ordered array of stage IDs.

    • outcomestringOptional

      Stage outcome for create or update. Won and Lost stop automatic progression.

      One of: open, won, lost

    • replacementStageIdstring | nullOptional

      Required for delete. Reassign leads to this stage, or explicitly null for No Stage.

    • actionstringRequired

      Action to perform. "list" returns all CRM pipeline stages. "create" adds a new stage. "update" modifies a stage. "delete" removes a stage. "reorder" sets the display order of all stages.

      One of: list, create, update, delete, reorder

    • stageIdstringOptional

      CRM stage ID (required for update, delete)

    • namestringOptional

      Stage name (required for create, optional for update)

    • colorstringOptional

      Hex color for the stage, e.g. "#3498db" (optional for create, update)

    • positionintegerOptional

      Stage position in the pipeline (optional for create)

    • stageIdsstring[]Optional

      Ordered array of all stage IDs to set display order (required for reorder)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_crm_leads

    destructive

    Manage leads in the CRM pipeline. "update_stage" moves a lead to a CRM stage. "update_assignee" assigns a lead to a team member. "get_crm_leads" lists leads with CRM-specific filters (stage, assignee). "get_stage_stats" returns lead counts per stage. Do NOT use for general lead queries without CRM filters (use brandjet_get_leads or brandjet_advanced_filter_leads).

    • expectedVersionintegerOptional

      Last observed stage version for update_stage.

    • reopenConfirmedbooleanOptional

      Explicitly confirm moving out of a Won or Lost stage.

    • actionstringRequired

      Action to perform. "update_stage" moves a lead to a CRM stage. "update_assignee" assigns a lead to a user. "get_crm_leads" lists leads with CRM filters (stage, assignee). "get_stage_stats" returns lead counts per CRM stage.

      One of: update_stage, update_assignee, get_crm_leads, get_stage_stats

    • leadIdstringOptional

      Lead ID (required for update_stage, update_assignee)

    • crmStageIdstring | nullOptional

      CRM stage ID to move the lead to. Pass null to unset. (action: update_stage)

    • assignedToIdstring | nullOptional

      User ID to assign the lead to. Pass null to unassign. (action: update_assignee)

    • stageIdstringOptional

      Filter leads by CRM stage (action: get_crm_leads)

    • assigneeIdstringOptional

      Filter leads by assignee (action: get_crm_leads)

    • searchstringOptional

      Search leads by name or email (action: get_crm_leads)

    • pageintegerOptional

      Page number (action: get_crm_leads, default: 1)

    • limitintegerOptional

      Items per page (action: get_crm_leads, default: 50)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_advanced_filter_leads

    read only
    idempotent

    Filter existing leads with AND/OR conditions. Each field supports only the operators and value types declared in the schema. ID equality uses a UUID, ID membership uses a nonempty UUID array, and boolean equality requires true or false. Invalid or unsupported filters return an error. Use for complex queries that brandjet_get_leads cannot handle.

    • logicstringOptional

      How to combine conditions: AND (all must match) or OR (any must match). Default: AND.

      One of: AND, OR

    • conditionsobject[]Required

      Array of filter conditions (max 20). Available fields: name, email, phoneNumber, source, isVerified, crmStageId, assignedToId, leadListId, createdAt, updatedAt, hasEmail, hasPhone, hasLinkedin, hasTwitter, hasInstagram, hasTelegram, linkedinMetadata.company, linkedinMetadata.headline, linkedinMetadata.location, campaignId, hasReplied, inAnyCampaign.

    • conditions[].fieldstring | "source"Required

      One of: name, email, phoneNumber, linkedinMetadata.company, linkedinMetadata.headline, linkedinMetadata.location, crmStageId, assignedToId, leadListId, campaignId, isVerified, hasEmail, hasPhone, hasLinkedin, hasTwitter, hasInstagram, hasTelegram, hasReplied, inAnyCampaign, optedOut, createdAt, updatedAt

    • conditions[].operatorstring | "between"Required

      One of: equals, not_equals, contains, not_contains, starts_with, ends_with, is_empty, is_not_empty, in, not_in, is_true, is_false, gt, lt, gte, lte

    • conditions[].valuestring | any | string[] | boolean | objectOptional
    • conditions[].value.fromstringRequired
    • conditions[].value.tostringRequired
    • sortFieldstringOptional

      Field to sort results by

      One of: name, email, createdAt, updatedAt, source

    • sortOrderstringOptional

      Sort direction (default: DESC)

      One of: ASC, DESC

    • pageintegerOptional

      Page number (default: 1)

    • limitintegerOptional

      Items per page (default: 25, max: 200)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_bulk_lead_operations

    destructive

    Perform bulk operations on multiple leads at once. "bulk_crm_stage" moves multiple leads to a shared pipeline stage. "bulk_assignee" assigns multiple leads. "bulk_delete" deletes leads by IDs or matching filters. For updating a single lead, use brandjet_update_lead instead. Confirm destructive actions before executing.

    • reopenConfirmedbooleanOptional

      Explicitly confirm moving selected leads out of Won or Lost stages.

    • actionstringRequired

      "bulk_crm_stage" moves multiple leads to a pipeline stage. "bulk_assignee" assigns multiple leads to a user. "bulk_delete" deletes leads by IDs or by matching filters.

      One of: bulk_crm_stage, bulk_assignee, bulk_delete

    • leadIdsstring[]Optional

      Lead IDs for bulk operations (required for bulk_crm_stage, bulk_assignee; optional for bulk_delete)

    • crmStageIdstring | nullOptional

      CRM stage to assign. Null = unset. (required for bulk_crm_stage)

    • assignedToIdstring | nullOptional

      User to assign leads to. Null = unassign. (required for bulk_assignee)

    • deleteAllMatchingbooleanOptional

      Delete all leads matching the filters below instead of specific IDs (action: bulk_delete)

    • leadListIdstringOptional

      Filter by lead list when using deleteAllMatching (action: bulk_delete)

    • verificationStatusstringOptional

      Filter by verification status when using deleteAllMatching (action: bulk_delete)

    • filterCrmStageIdstringOptional

      Filter by pipeline stage when using deleteAllMatching (action: bulk_delete)

    • searchstringOptional

      Filter by search text when using deleteAllMatching (action: bulk_delete)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_lead_timeline

    read only
    idempotent

    Get the per-lead activity timeline and sequence position. Returns chronological events (messages sent, opens, clicks, replies, executed workflow steps, status/CRM changes, notes, campaign enrollments, enrichment). Pass includeSummary:true to also receive current workflow step per active execution and the next scheduled action time. Supports pagination and filtering by event type (comma-separated).

    • leadIdstringRequired

      Lead ID to get activity timeline for

    • pageintegerOptional

      Page number (default: 1)

    • limitintegerOptional

      Items per page (default: 25)

    • typestringOptional

      Filter by event type (comma-separated). Supported: NOTE, CAMPAIGN_ADDED, CAMPAIGN_EXECUTION_STATUS, EXECUTION_STEP, CAMPAIGN_EVENT, EMAIL_EVENT, LINKEDIN_EVENT, TWITTER_EVENT, INSTAGRAM_EVENT, WHATSAPP_EVENT, TELEGRAM_EVENT, CONVERSATION_CREATED, STAGE_CHANGED

    • includeSummarybooleanOptional

      If true, include a summary block with current workflow step per active execution and the next scheduled action (send/open/click) for the lead.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_suppression_status

    read only
    idempotent

    Check whether email addresses are suppressed for the current brand. Read-only. Works by address, so it also covers deleted or archived leads. Each result lists every match with its scope and reason: "brand" (this brand's suppression list: hard_bounce, unsubscribe, spam_complaint, manual, with suppressedAt), "global" (platform-wide address suppression) and "global_domain" (platform-wide domain suppression), both with reason "global" and suppressedAt null because they can come from other brands' events, and "brand_blocklist" (the brand's blocked domains). brand, global and global_domain matches block these emails to the address: campaign steps (a campaign's own CC or BCC is dropped from the step), new outreach (brandjet_send_outreach_message), replies in existing conversations (brandjet_send_message, drafts and scheduled replies, including CC and BCC), auto-replies, proposal signing requests and reminders, and workflow emails. brand_blocklist matches block the same emails except manual replies in an existing conversation and proposal emails; campaign sends also check the lead's company domain, which this lookup does not see. Campaign-only blocked domains are not included. Each address checked counts toward the brand's daily limit, shared with POST /v1/leads/suppression-check; plans without a daily API request limit have none. Requires leads:read scope.

    • emailsstring[]Required

      Email addresses to check (1-500). Matching is case-insensitive and does not require the address to belong to an existing lead.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_email_accounts

    read only
    idempotent

    Get email accounts for the current brand. Without accountId: lists all email accounts with pagination and filtering by provider, status, and search. With accountId: returns full details for that specific account. Each response includes warmupReadiness: { isReady, daysWarmedUp, recommendedDailyLimit } so you can decide if the account is safe to use for cold outbound (isReady requires 30+ days warmed and status=CONNECTED with warmup ACTIVE).

    • accountIdstringOptional

      Email account ID. If provided, returns full details for that account. If omitted, lists all email accounts for the current brand.

    • providerstringOptional

      Filter by email provider (google, outlook, azure, smtp)

      One of: google, outlook, azure, smtp

    • statusstringOptional

      Filter by account status (connected, disconnected, error, pending)

      One of: connected, disconnected, error, pending

    • searchstringOptional

      Search by account name or email address

    • pageintegerOptional

      Page number (default: 1)

    • limitintegerOptional

      Items per page (default: 50, max: 100)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_email_accounts

    destructive

    Manage email account settings: update sending limits, signature, and display name; verify connection; delete accounts; or bulk operations. Does not support creation (email accounts must be connected through OAuth or SMTP in the app). For warmup management, use brandjet_manage_email_warmup instead.

    • actionstringOptional

      Action to perform. "update" (default) modifies account settings. "verify" tests the connection and updates status. "delete" removes the account. "bulk_update_limits" updates sending limits for multiple accounts. "bulk_delete" deletes multiple accounts.

      One of: update, verify, delete, bulk_update_limits, bulk_delete

    • accountIdstringOptional

      Email account ID (required for update, verify, delete)

    • accountIdsstring[]Optional

      Email account IDs (required for bulk_update_limits, bulk_delete)

    • namestringOptional

      Updated display name (action: update)

    • replyToAddressstringOptional

      Updated reply-to email address (action: update)

    • signaturestringOptional

      Updated email signature HTML (action: update)

    • bccToCrmstringOptional

      BCC email for CRM forwarding (action: update)

    • dailyLimitintegerOptional

      Maximum emails per day (action: update, bulk_update_limits)

    • hourlyLimitintegerOptional

      Maximum emails per hour (action: update, bulk_update_limits)

    • minimumTimeGapintegerOptional

      Minimum minutes between emails (action: update, bulk_update_limits)

    • randomAdditionalMinutesintegerOptional

      Random additional minutes between emails for human-like sending (action: update, bulk_update_limits)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_integrations

    read only
    idempotent

    Get integrations for the current brand. Without integrationId: lists all integrations, optionally filtered by type or active-only. With integrationId: returns full details including platform-specific profile metadata (LinkedIn, Instagram, WhatsApp, Reddit).

    • integrationIdstringOptional

      Integration ID. If provided, returns full details including platform-specific profile metadata. If omitted, lists all integrations for the current brand.

    • typestringOptional

      Filter by integration type (e.g., linkedin, twitter, instagram)

      One of: slack, discord, teams, webhook, twitter, instagram, reddit, youtube, linkedin, whatsapp

    • activeOnlybooleanOptional

      If true, only return active and enabled integrations (default: false)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_integrations

    destructive

    Manage integrations: update settings (action="update"), toggle enabled/disabled (action="toggle"), delete (action="delete"), or bulk delete (action="bulk_delete"). Does not support creation — integrations must be connected through the platform-specific OAuth flow in the app.

    • actionstringRequired

      Action to perform. "update" modifies name, description, or enabled state. "toggle" flips enabled/disabled. "delete" removes the integration. "bulk_delete" removes multiple integrations.

      One of: update, toggle, delete, bulk_delete

    • integrationIdstringOptional

      Integration ID (required for update, toggle, delete)

    • integrationIdsstring[]Optional

      Integration IDs (required for bulk_delete)

    • namestringOptional

      Updated display name (action: update)

    • descriptionstringOptional

      Updated description (action: update)

    • isEnabledbooleanOptional

      Enable or disable the integration (action: update)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_website_analytics

    Manage website analytics configuration (setup, not data). Register a website for tracking, get/update config, remove tracking, get embed code, or regenerate the tracking key. Do NOT use to retrieve analytics data or statistics (use brandjet_get_website_analytics or brandjet_get_website_analytics_breakdown).

    • actionstringRequired

      Action to perform. "register" sets up website tracking (requires domain). "get_config" returns current config. "update" changes the website name. "remove" deletes the website. "get_embed_code" returns the tracking script. "regenerate_key" creates a new tracking key and embed code.

      One of: register, get_config, update, remove, get_embed_code, regenerate_key

    • domainstringOptional

      Website domain without protocol (required for register). Example: "example.com"

    • namestringOptional

      Display name for the website (optional for register, used for update)

    • timezonestringOptional

      Timezone for analytics data (optional for register, default: UTC). Example: "America/New_York"

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_website_analytics

    read only
    idempotent
    open world

    Get website analytics statistics and visitor data. Use "dashboard" for a full overview, or specific actions for individual metrics. Per-page, per-country, and per-referrer breakdowns expose visitors only (aggregate pageviews and bounce rate are surfaced on "main_stats"). Do NOT use for analytics configuration or setup (use brandjet_manage_website_analytics). For advanced breakdowns with filtering, use brandjet_get_website_analytics_breakdown.

    • actionstringRequired

      Stat to retrieve. "dashboard" returns a full summary (main stats, visitors chart, top countries, pages, referrers, browsers, devices). "main_stats" returns core metrics (pageviews, visitors, bounce rate, visit duration, pages per visit) with period comparison. "visitors_chart" returns time-series visitor data. "countries/pages/referrers/browsers/devices" return specific breakdowns. "check_events" checks whether the tracking script has received any events.

      One of: dashboard, main_stats, visitors_chart, countries, pages, referrers, browsers, devices, check_events

    • presetstringOptional

      Date range preset (default: last_7_days). Use "custom" with startDate and endDate for a specific range.

      One of: today, yesterday, last_7_days, last_30_days, last_90_days, this_month, last_month, custom

    • startDatestringOptional

      Start date in ISO format (required when preset is "custom"). Example: "2026-01-01"

    • endDatestringOptional

      End date in ISO format (required when preset is "custom"). Example: "2026-01-31"

    • granularitystringOptional

      Time granularity for chart data: "hour" or "day"

      One of: hour, day

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_website_analytics_breakdown

    read only
    idempotent
    open world

    Get advanced website analytics breakdowns with optional filtering. Breakdowns include traffic channels, UTM campaigns, cities, entry pages, exit links, operating systems, and languages. Use filter parameters to narrow results (e.g., filter by country, browser, or referrer).

    • actionstringRequired

      Breakdown to retrieve. "channels" shows traffic channels (direct, organic, social, etc.) with top sources per channel. "campaigns" shows UTM campaign breakdown (campaign, source, medium). "cities" shows city-level geographic data. "entry_pages" shows first pages visited. "exit_links" shows external link clicks. "os" shows operating system distribution. "languages" shows visitor language distribution. All support optional filters to narrow results.

      One of: channels, campaigns, cities, entry_pages, exit_links, os, languages

    • presetstringOptional

      Date range preset (default: last_7_days). Use "custom" with startDate and endDate for a specific range.

      One of: today, yesterday, last_7_days, last_30_days, last_90_days, this_month, last_month, custom

    • startDatestringOptional

      Start date in ISO format (required when preset is "custom")

    • endDatestringOptional

      End date in ISO format (required when preset is "custom")

    • granularitystringOptional

      Time granularity: "hour" or "day"

      One of: hour, day

    • referrerstringOptional

      Filter by referrer source (e.g., "google.com")

    • campaignstringOptional

      Filter by UTM campaign name

    • pagestringOptional

      Filter by page path (e.g., "/pricing")

    • entryPagestringOptional

      Filter by entry page path

    • countrystringOptional

      Filter by country code (e.g., "US")

    • citystringOptional

      Filter by city name

    • browserstringOptional

      Filter by browser name (e.g., "Chrome")

    • osstringOptional

      Filter by operating system (e.g., "Windows")

    • languagestringOptional

      Filter by language code (e.g., "en")

    • channelstringOptional

      Filter by traffic channel (e.g., "organic", "direct", "social")

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_mentions

    read only
    idempotent
    open world

    Get individual brand mentions with full content, author, sentiment, and engagement data. Without mentionId: returns a paginated list with rich filtering — each row carries a competitor attribute (null for brand-owned mentions) so consumers can filter client-side. For a complete competitive brief, either iterate every competitor from brandjet_get_competitors calling this tool per competitorId, or call without competitorId/competitorIds/brandOnly to get brand + all competitor mentions in one paginated feed. Low mention volume for a competitor is itself a signal — never skip a competitor during a brief. With mentionId: returns full details including replies. Do NOT use for aggregate statistics (use brandjet_get_mention_stats) or sentiment analytics (use brandjet_get_sentiment_dashboard).

    • mentionIdstringOptional

      Mention ID. If provided, returns full details for that mention including replies. If omitted, returns a paginated list of mentions with filters.

    • platformsstring[]Optional

      Filter by platform(s). Example: ["twitter", "reddit"]

      One of: twitter, reddit, youtube, news, linkedin, tiktok

    • sentimentTypestringOptional

      Filter by sentiment type

      One of: positive, negative, neutral, mixed

    • statusstringOptional

      Filter by mention status (unread, read, archived, needs_response, responded)

      One of: unread, read, archived, needs_response, responded

    • prioritystringOptional

      Filter by mention priority (low, medium, high)

      One of: low, medium, high

    • searchstringOptional

      Search within mention content (case-insensitive)

    • matchedKeywordstringOptional

      Filter by the keyword that triggered this mention

    • minEngagementintegerOptional

      Minimum engagement count filter

    • isCrisisAlertbooleanOptional

      Filter for crisis alerts only

    • brandOnlybooleanOptional

      When true, excludes competitor mentions and shows only brand-owned mentions (competitorId IS NULL). When omitted or false, returns brand + all competitor mentions together in one paginated feed.

    • competitorIdstringOptional

      Filter mentions for a specific competitor. Use this OR competitorIds, not both (competitorId wins if both are set).

    • competitorIdsstring[]Optional

      Filter mentions across multiple competitors in one call. Mutually exclusive with competitorId.

    • startDatestringOptional

      Filter mentions published after this ISO date. Example: "2026-01-01T00:00:00Z"

    • endDatestringOptional

      Filter mentions published before this ISO date. Example: "2026-02-01T00:00:00Z"

    • sortBystringOptional

      Sort field (default: publishedAt)

      One of: createdAt, publishedAt, engagementCount, sentimentScore, reachEstimate

    • sortOrderstringOptional

      Sort direction (default: DESC)

      One of: ASC, DESC

    • pageintegerOptional

      Page number (default: 1)

    • limitintegerOptional

      Items per page (default: 20, max: 100)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_mention_stats

    read only
    idempotent

    Get aggregate mention statistics (totals, by-platform, by-sentiment, engagement averages). Do NOT use to retrieve individual mention posts (use brandjet_get_mentions) or sentiment trends/drivers (use brandjet_get_sentiment_dashboard).

    • actionstringRequired

      Stat type to retrieve. "overview" returns total mentions, by-platform, by-sentiment, recent 24h, and avg engagement. "counts" returns simple sentiment breakdown counts (positive, negative, neutral, total). "live" returns comprehensive real-time stats with platform distribution, top keywords, engagement metrics, and hourly trend data.

      One of: overview, counts, live

    • timeframestringOptional

      Timeframe for live stats (only used with action "live", default: "24h")

      One of: 24h, 1w, lifetime

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_mentions

    destructive

    Manage brand mentions. "update_status" changes a single mention's status. "bulk_update_status" changes status for multiple mentions. "bulk_delete" permanently deletes mentions. "delete_by_keyword" permanently deletes mentions collected for a matched keyword. "collect" triggers manual mention collection across all enabled platforms and returns per-platform counts, or status "running" when collection is still in progress after about 40 seconds (it keeps going in the background).

    • actionstringRequired

      Action to perform. "update_status" changes a single mention's status. "bulk_update_status" changes status for multiple mentions at once. "bulk_delete" permanently deletes multiple mentions. "delete_by_keyword" permanently deletes mentions collected for a matched keyword. "collect" triggers manual mention collection across all enabled platforms for the brand (may take time to complete).

      One of: update_status, bulk_update_status, bulk_delete, delete_by_keyword, collect

    • mentionIdstringOptional

      Mention ID (required for update_status)

    • mentionIdsstring[]Optional

      Array of mention IDs (required for bulk_update_status and bulk_delete)

    • matchedKeywordstringOptional

      Matched keyword to delete mentions for (required for delete_by_keyword)

    • competitorIdstringOptional

      Competitor ID when deleting mentions for a competitor keyword

    • statusstringOptional

      New status to set (required for update_status and bulk_update_status). Options: unread, read, archived, needs_response, responded.

      One of: unread, read, archived, needs_response, responded

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_mention_reply

    destructive

    Reply to brand mentions. "reply" posts a reply on the original platform. Requires confirmed: true to actually post; otherwise returns a preview. Twitter replies are temporarily disabled. Reddit and YouTube resolve the single active integration for the brand (socialAccountId is ignored). LinkedIn uses socialAccountId when multiple LinkedIn integrations are connected. "generate_ai_reply" generates an AI-powered reply suggestion (paid plans only). "get_replies" lists all replies for a mention. "delete_reply" removes a reply record.

    • actionstringRequired

      Action to perform. "reply" posts a reply to a mention on the original platform (Twitter is temporarily disabled; Reddit, YouTube, LinkedIn supported). "generate_ai_reply" generates an AI-powered reply suggestion based on the mention content and brand context (paid plans only). "get_replies" lists all replies posted for a specific mention. "delete_reply" removes a reply record.

      One of: reply, generate_ai_reply, get_replies, delete_reply

    • mentionIdstringOptional

      Mention ID (required for reply, generate_ai_reply, get_replies)

    • replyTextstringOptional

      Text content of the reply (required for action "reply")

    • socialAccountIdstringOptional

      Specific integration account ID to use for the reply (LinkedIn only — Reddit and YouTube resolve the single active integration for the brand). Takes precedence over accountId when both are supplied.

    • accountIdstringOptional

      Deprecated alias for socialAccountId. Prefer socialAccountId in new code.

    • confirmedbooleanOptional

      Required true for action "reply" to actually post. When omitted or false, returns a preview with needsConfirmation: true (no DB write, no platform call). Always review the preview before passing confirmed: true.

    • replyIdstringOptional

      Reply ID (required for delete_reply)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_sentiment_dashboard

    read only
    idempotent

    Get computed sentiment analytics: distribution, trends, drivers, highlights, platform breakdowns, KPIs, and time-series charts. Returns analytical data, not individual mentions. Do NOT use to retrieve raw mention data (use brandjet_get_mentions) or simple mention counts (use brandjet_get_mention_stats).

    • actionstringRequired

      Dashboard view to retrieve. "dashboard" returns sentiment distribution with period-over-period comparison. "metrics" returns avg sentiment score, velocity, and response rate. "trends" returns daily sentiment trends over the timeframe. "drivers" returns top positive and negative sentiment drivers with themes and sample quotes. "highlights" returns significant sentiment shifts and trending topics across multiple timeframes. "platform_breakdown" returns per-platform mention counts with sentiment split. "chart" returns time-series chart data with sentiment scores and volume. "kpi" returns full KPI dashboard: total mentions, sentiment score, AI visibility score, and total reach with period comparisons.

      One of: dashboard, metrics, trends, drivers, highlights, platform_breakdown, chart, kpi

    • timeframestringOptional

      Analysis timeframe (default: "7d"). Not used for "highlights" action which analyzes across multiple timeframes automatically.

      One of: 1d, 3d, 7d, 14d, 30d

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_shared_reports

    destructive

    Manage public shared reports for brand monitoring data. "create" generates a new public report link with a chosen timeframe. "get" retrieves the currently active shared report. "revoke" deactivates the report, making the public link inaccessible.

    • actionstringRequired

      Action to perform. "create" generates a new public shared report link for the brand. "get" retrieves the currently active shared report for this brand. "revoke" deactivates the active shared report, making the public link inaccessible.

      One of: create, get, revoke

    • timeframestringOptional

      Report timeframe (required for "create", default: "7d")

      One of: 24h, 7d, 30d

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_agents

    read only
    idempotent

    Get AI agents for the current brand. "list" returns paginated agents with execution stats and account assignments. "get" returns full details for a specific agent. "types" returns available agent types.

    • actionstringRequired

      Action to perform. "list" returns paginated agents for the current brand with execution stats. "get" returns full details for a specific agent (requires agentId). "types" returns available agent types that can be created.

      One of: list, get, types

    • agentIdstringOptional

      Agent ID (required for "get" action)

    • pageintegerOptional

      Page number (default: 1, for "list" action)

    • limitintegerOptional

      Items per page (default: 20, for "list" action)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_agents

    destructive

    Manage AI agents. "create" creates a new agent. "update" modifies an agent. "delete" removes an agent. "activate"/"deactivate" toggle agent state. "duplicate" clones an agent. "scan" triggers manual mention scan. "generate_config" uses AI to generate configuration.

    • actionstringRequired

      Action to perform. "create" creates a new AI agent. "update" modifies an existing agent. "delete" permanently deletes an agent. "activate" enables an agent. "deactivate" pauses an agent. "duplicate" clones an existing agent. "scan" triggers a manual mention scan. "generate_config" uses AI to generate agent configuration from natural language.

      One of: create, update, delete, activate, deactivate, duplicate, scan, generate_config

    • agentIdstringOptional

      Agent ID (required for update, delete, activate, deactivate, duplicate, scan)

    • typestringOptional

      Agent type (required for "create")

      One of: mention_reply, lead_collector, conversation_reply

    • namestringOptional

      Agent name (required for "create")

    • descriptionstringOptional

      Agent description

    • isActivebooleanOptional

      Whether agent should be active on creation

    • requiresApprovalbooleanOptional

      Whether agent replies need manual approval before posting

    • personalityobjectOptional

      Agent personality configuration

    • personality.rolestringOptional

      Role the agent embodies (e.g., "Product Expert", "Community Manager")

    • personality.namestringOptional

      Display name the agent uses when replying

    • personality.tonestringOptional

      One of: professional, friendly, casual, formal, helpful, empathetic

    • personality.contextstringOptional

      Background context about the brand or product the agent should know

    • personality.additionalInstructionsstringOptional

      Extra instructions for reply generation (e.g., "always include a CTA", "keep replies under 280 chars")

    • conditionsobjectOptional

      Conditions for when the agent should act

    • conditions.platformsstring[]Optional

      Platforms to monitor: twitter, reddit, linkedin, youtube

    • conditions.sentimentstring[]Optional

      Sentiment types: positive, neutral, negative

    • conditions.keywordsstring[]Optional

      Keywords that trigger responses

    • conditions.excludeKeywordsstring[]Optional

      Keywords that prevent responses

    • conditions.authorMinFollowersintegerOptional

      Only respond to authors with at least this many followers

    • conditions.authorMaxFollowersintegerOptional

      Only respond to authors with at most this many followers

    • conditions.authorVerifiedOnlybooleanOptional

      Only respond to verified or blue-check authors

    • sampleRepliesstring[]Optional

      Sample replies for tone calibration

    • newNamestringOptional

      Name for the duplicated agent (for "duplicate" action)

    • agentTypestringOptional

      Agent type for AI generation (required for "generate_config")

      One of: mention_reply, lead_collector, conversation_reply

    • userContextstringOptional

      Natural language description of what the agent should do (required for "generate_config", max 2000 chars)

    • targetLeadListIdstringOptional

      Target lead list ID (for lead_collector agents)

    • linkedCampaignIdstringOptional

      Linked campaign ID (for lead_collector agents)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_agent_accounts

    destructive

    Manage account assignments for AI agents. "list" shows all assignments. "assign" adds an account. "update" modifies priority/active. "remove" detaches an account. "stats" returns assignment statistics.

    • actionstringRequired

      Action to perform. "list" returns all account assignments for an agent. "assign" adds an integration account to the agent. "update" modifies an assignment priority or active status. "remove" detaches an account from the agent. "stats" returns aggregated account assignment statistics.

      One of: list, assign, update, remove, stats

    • agentIdstringRequired

      Agent ID (required for all actions)

    • integrationIdstringOptional

      Integration account ID (required for "assign" and "remove")

    • assignmentIdstringOptional

      Assignment ID (required for "update")

    • priorityintegerOptional

      Assignment priority (higher = preferred). Used with "assign" and "update".

    • isActivebooleanOptional

      Whether the assignment is active. Used with "update".

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_agent_executions

    read only
    idempotent

    View AI agent execution history, details, logs, and statistics. "list" returns paginated history with filters. "get" returns execution details. "logs" returns step logs. "by_agent"/"by_mention" return filtered executions. "stats" returns aggregated statistics.

    • actionstringRequired

      Action to perform. "list" returns paginated execution history with filters. "get" returns full details for a specific execution. "logs" returns processing step logs for an execution. "by_agent" returns recent executions for a specific agent. "by_mention" returns all executions for a specific mention. "stats" returns execution statistics with success rate and status breakdown.

      One of: list, get, logs, by_agent, by_mention, stats

    • executionIdstringOptional

      Execution ID (required for "get" and "logs")

    • agentIdstringOptional

      Agent ID (required for "by_agent" and "stats", optional filter for "list")

    • mentionIdstringOptional

      Mention ID (required for "by_mention")

    • statusstringOptional

      Filter by execution status (for "list" action)

      One of: pending, evaluating, generating, awaiting_approval, executing, completed, failed, skipped, rate_limited

    • pageintegerOptional

      Page number (default: 1)

    • limitintegerOptional

      Items per page (default: 20)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_pending_replies

    destructive

    Manage AI agent pending replies. "list" returns paginated replies with filters. "get" returns reply details. "approve" approves a reply (optionally with edits). "reject" rejects with reason. "bulk_approve"/"bulk_reject" for batch operations. "count" returns pending count. "badge_summary" returns per-agent breakdown.

    • actionstringRequired

      Action to perform. "list" returns paginated pending replies with filters. "get" returns full details for a specific pending reply. "approve" approves a reply for posting (optionally with edited text). "reject" rejects a reply with optional reason. "bulk_approve" approves multiple replies. "bulk_reject" rejects multiple replies. "count" returns the number of pending approvals. "badge_summary" returns total pending count and per-agent breakdown.

      One of: list, get, approve, reject, bulk_approve, bulk_reject, count, badge_summary

    • replyIdstringOptional

      Pending reply ID (required for "get", "approve", "reject")

    • replyIdsstring[]Optional

      Array of pending reply IDs (required for "bulk_approve", "bulk_reject")

    • agentIdstringOptional

      Filter by agent ID (for "list" action)

    • statusstringOptional

      Filter by status (for "list" action)

      One of: pending, approved, rejected, expired, executed, failed

    • editedTextstringOptional

      Edited reply text to use instead of AI-generated text (for "approve")

    • reasonstringOptional

      Rejection reason (for "reject" and "bulk_reject")

    • pageintegerOptional

      Page number (default: 1, for "list" action)

    • limitintegerOptional

      Items per page (default: 20, for "list" action)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_llm_monitors

    destructive

    Manage LLM monitors that track brand visibility across AI models. Actions: list/get/create/update/delete monitors, plus retry_setup to re-run setup for a monitor stuck in setting_up. Monitor setup runs asynchronously after create_monitor: status transitions from setting_up to active, typically within two minutes. Do NOT use for personas (use brandjet_manage_personas), models (use brandjet_get_available_models), dashboard analytics (use brandjet_get_llm_dashboard), or query management (use brandjet_get_llm_queries or brandjet_manage_llm_queries).

    • actionstringRequired

      Action to perform. "list_monitors" lists all monitors for the brand. "get_monitor" returns full monitor details. "create_monitor" creates a new monitor. "update_monitor" modifies a monitor. "delete_monitor" removes a monitor. "retry_setup" re-runs setup for a monitor stuck in setting_up.

      One of: list_monitors, get_monitor, create_monitor, update_monitor, delete_monitor, retry_setup

    • monitorIdstringOptional

      Monitor ID (required for get_monitor, update_monitor, delete_monitor, retry_setup)

    • personaIdstringOptional

      Persona ID (required for create_monitor)

    • namestringOptional

      Name (for create/update monitor)

    • descriptionstringOptional

      Description (for create/update monitor)

    • languagestringOptional

      Language code, e.g. "en" (for create/update monitor)

    • countrystringOptional

      Country, e.g. "US" (for create/update monitor)

    • initialPromptstringOptional

      Initial prompt instructions (for create/update monitor)

    • selectedModelsstring[]Optional

      Array of LLM model IDs to use (for create/update monitor)

    • isActivebooleanOptional

      true activates the monitor (re-driving asynchronous setup when needed: status becomes setting_up, then active), false deactivates it (for update_monitor)

    • runFrequencystringOptional

      How often every active question runs on each selected model: "daily", "weekly", or "monthly". Defaults to "weekly" on create_monitor; on update_monitor, each question is rescheduled from its last run (for create/update monitor)

      One of: daily, weekly, monthly

    • initialQueriesobject[]Optional

      User-reviewed queries to persist at creation; when provided, setup skips AI auto-generation (for create_monitor)

    • initialQueries[].queryTextstringRequired
    • initialQueries[].categorystringOptional

      One of: direct_brand, competitor_comparison, industry_recommendations, problem_solving, sentiment_probing, use_case_specific, news_and_trends, technical_evaluation

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_personas

    Manage buyer personas for LLM monitoring. Personas define target audience profiles used for query generation. Do NOT use for monitor management (use brandjet_manage_llm_monitors).

    • actionstringRequired

      Action to perform. "list" lists all personas for the brand. "create" creates a new persona. "update" modifies a persona. "delete" removes a persona. "suggest" uses AI to suggest a new persona configuration.

      One of: list, create, update, delete, suggest

    • personaIdstringOptional

      Persona ID (required for update, delete)

    • namestringOptional

      Persona name (required for create)

    • descriptionstringOptional

      Persona description

    • ageRangestringOptional

      Persona age range: 18_24, 25_34, 35_44, 45_54, 55_64, 65_plus

    • educationLevelstringOptional

      Persona education: high_school, bachelors, masters, doctorate, vocational, other

    • excludeNamesstring[]Optional

      Names to exclude when suggesting a persona

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_available_models

    read only
    idempotent

    Get the list of available LLM models that can be used for AI monitoring. Returns models grouped by platform.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_llm_dashboard

    read only
    idempotent

    Get LLM monitoring dashboard analytics and insights. "summary" returns the monitoring overview for the selected brand. "insights" returns brand AI insights with sentiment and recommendations. "visibility_score" returns brand visibility trend over time. "model_statistics" returns per-model performance scores. "monitor_visibility" and "monitor_model_stats" return monitor-level analytics. Do NOT use to manage monitors or personas (use brandjet_manage_llm_monitors). Do NOT use to view individual queries (use brandjet_get_llm_queries).

    • actionstringRequired

      Action to perform. "summary" returns the monitoring summary for the selected brand. "insights" returns brand-level AI insights. "visibility_score" returns brand visibility over time. "model_statistics" returns per-model performance stats. "monitor_visibility" returns visibility for a specific monitor. "monitor_model_stats" returns model stats for a specific monitor.

      One of: summary, insights, visibility_score, model_statistics, monitor_visibility, monitor_model_stats

    • monitorIdstringOptional

      Monitor ID (required for monitor_visibility, monitor_model_stats)

    • daysintegerOptional

      Number of days to look back (default: 7 for visibility, 30 for stats)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_llm_queries

    read only
    idempotent

    Get LLM monitoring queries and responses. "list" returns paginated queries with filters (category, search, monitor, persona). "details" returns full query details with all responses and analysis. "responses" returns paginated responses. "blog_strategy" generates AI content recommendations based on query responses.

    • actionstringRequired

      Action to perform. "list" returns paginated queries with filters. "details" returns full query details with responses and analysis. "responses" returns paginated responses with filters. "blog_strategy" generates AI-powered blog content recommendations based on query responses.

      One of: list, details, responses, blog_strategy

    • queryIdstringOptional

      Query ID (required for "details" and "blog_strategy")

    • monitorIdstringOptional

      Filter by monitor ID (for "list" and "responses")

    • personaIdstringOptional

      Filter by persona ID (for "list")

    • daysintegerOptional

      Days to look back (default: 7, valid: 7, 14, 30, 90)

    • categorystringOptional

      Filter by query category (for "list")

    • searchstringOptional

      Search text in queries or responses (for "list" and "responses")

    • sortBystringOptional

      Sort field: queryText, category, mentionCount, lastExecutedAt, createdAt (for "list")

    • sortOrderstringOptional

      Sort direction (default: DESC)

      One of: ASC, DESC

    • modestringOptional

      Response mode: "full" includes responses, "minimal" is lighter (for "list")

      One of: full, minimal

    • pageintegerOptional

      Page number (default: 1)

    • limitintegerOptional

      Items per page (default: 20)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_llm_queries

    destructive

    Manage LLM monitoring queries. "bulk_activate" activates multiple queries. "bulk_deactivate" pauses queries. "bulk_delete" permanently removes queries. "create_custom" creates a custom monitoring query with optional immediate execution.

    • actionstringRequired

      Action to perform. "bulk_activate" activates multiple queries. "bulk_deactivate" deactivates multiple queries. "bulk_delete" deletes multiple queries. "create_custom" creates a custom monitoring query.

      One of: bulk_activate, bulk_deactivate, bulk_delete, create_custom

    • queryIdsstring[]Optional

      Array of query IDs (required for bulk_activate, bulk_deactivate, bulk_delete)

    • monitorIdstringOptional

      Monitor ID (required for "create_custom")

    • queryTextstringOptional

      Query text (required for "create_custom")

    • categorystringOptional

      Query category (required for "create_custom")

      One of: direct_brand, competitor_comparison, industry_recommendations, problem_solving, sentiment_probing, use_case_specific, news_and_trends, technical_evaluation

    • priorityintegerOptional

      Priority 1-4: low, medium, high, critical (for "create_custom")

    • queryLanguagestringOptional

      Language code for the query, e.g. "en-US" (for "create_custom")

    • notesstringOptional

      Notes about the query (for "create_custom")

    • executeImmediatelybooleanOptional

      Execute query immediately after creation (default: true, for "create_custom")

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_competitors

    read only
    idempotent

    Get competitors for the current brand. "list" returns all competitors with keywords, platforms, mention counts, and collection status. "get" returns full details for one competitor. "enhancement_status" returns enhancement pipeline progress. A complete competitive brief must always iterate every competitor returned here — low mention volume is itself a signal, never skip. Use brandjet_get_mentions with competitorIds[] or no competitor filter to retrieve the underlying mentions.

    • actionstringRequired

      Action to perform. "list" returns all competitors for the brand. "get" returns full details for a specific competitor (requires competitorId). "enhancement_status" returns enhancement pipeline progress (requires competitorId).

      One of: list, get, enhancement_status

    • competitorIdstringOptional

      Competitor ID (required for "get" and "enhancement_status")

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_competitors

    destructive

    Manage competitors. "create" adds a new competitor (plan limits apply). "update" modifies details. "delete" removes a competitor and all its data. "toggle_active" flips monitoring. "update_platforms" changes monitored platforms.

    • actionstringRequired

      "create" adds a new competitor (subject to plan limits). "update" modifies an existing competitor. "delete" permanently removes a competitor and all its mentions and data. "toggle_active" flips monitoring on/off. "update_platforms" changes monitored platforms.

      One of: create, update, delete, toggle_active, update_platforms

    • competitorIdstringOptional

      Competitor ID (required for update, delete, toggle_active, update_platforms)

    • namestringOptional

      Competitor name (required for "create", optional for "update")

    • websitestringOptional

      Competitor website URL

    • logostringOptional

      Competitor logo URL. Ignored unless it is an http(s) URL that fits the 255 character storage limit; an unusable value never blocks the competitor.

    • platformsobjectOptional

      Platform monitoring toggles. Each platform: true (monitor) or false (ignore).

    • platforms.twitterbooleanOptional
    • platforms.redditbooleanOptional
    • platforms.newsbooleanOptional
    • platforms.youtubebooleanOptional
    • platforms.linkedinbooleanOptional
    • platforms.tiktokbooleanOptional
    • keywordsobject[]Optional

      Keywords to monitor (only for "update"). Replaces all existing keywords.

    • keywords[].valuestringRequired

      Keyword to monitor

    • keywords[].tagstringOptional

      Tag for categorization

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_competitor_action

    Trigger async competitor actions. "enhance" starts the enhancement pipeline (website analysis, keyword generation, collection setup). "collect" triggers manual mention collection across enabled platforms.

    • actionstringRequired

      "enhance" starts async enhancement: website scraping, keyword generation, collection setup. Poll progress with brandjet_get_competitors enhancement_status. "collect" triggers manual mention collection across enabled platforms.

      One of: enhance, collect

    • competitorIdstringRequired

      Competitor ID

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_support_tickets

    read only
    idempotent

    Get support tickets for the current user. Without ticketId: returns a paginated list with optional status and category filters. With ticketId: returns full ticket details including comments and attachments.

    • ticketIdstringOptional

      Ticket ID. If provided, returns full ticket details including comments and attachments. If omitted, returns a paginated list of the user's tickets.

    • statusstringOptional

      Filter by ticket status

      One of: open, in_progress, awaiting_response, resolved, closed

    • categorystringOptional

      Filter by ticket category

      One of: bug_report, feature_request, general_support

    • pageintegerOptional

      Page number (default: 1)

    • limitintegerOptional

      Items per page (default: 10, max: 100)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_create_support_ticket

    destructive

    Create a new support ticket for the current user. Requires a subject, description, and category. Priority defaults to "medium" if not specified.

    • subjectstringRequired

      Ticket subject/title (max 255 characters)

    • descriptionstringRequired

      Detailed description of the issue or request

    • categorystringRequired

      Ticket category. "bug_report" for bugs/errors, "feature_request" for new feature ideas, "general_support" for general help.

      One of: bug_report, feature_request, general_support

    • prioritystringOptional

      Ticket priority (default: "medium"). Use "urgent" only for critical production issues.

      One of: low, medium, high, urgent

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_support_tickets

    destructive

    Add a comment to an existing support ticket. Only supports the "add_comment" action. Do NOT use to create new tickets (use brandjet_create_support_ticket) or to view tickets (use brandjet_get_support_tickets).

    • actionstringRequired

      Action to perform. "add_comment" adds a comment to an existing ticket.

      One of: add_comment

    • ticketIdstringRequired

      Ticket ID (required for all actions)

    • contentstringOptional

      Comment text content (required for add_comment)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_list_all_tools

    read only
    idempotent

    List all available BrandJet MCP tools with their descriptions and categories. Use this to discover tools you might not know about. Filter by category to narrow results.

    • categorystringOptional

      Filter by category (e.g., "campaigns", "leads", "unibox", "enrichment", "ai_agents", "mentions", "llm_monitoring", "website_analytics", "support", "brand", "integrations", "email_accounts", "navigation"). Omit to list all tools.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_user_settings

    read only
    idempotent

    Get current user settings. type="profile" returns user profile info (name, email, company, position, bio). type="notifications" returns notification preferences (email toggles, frequency, thresholds). type="subscription" returns the plan details, usage limits, and usage stats of the brand the call works on, under its owner's plan.

    • typestringRequired

      Type of settings to retrieve. "profile" returns user profile info (name, email, company, etc.). "notifications" returns notification preferences (email toggles, frequency, thresholds). "subscription" returns current plan details and usage limits.

      One of: profile, notifications, subscription

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_user_settings

    destructive

    Update current user settings. action="update_profile" updates profile fields (firstName, lastName, phone, company, position, bio, website, country). action="update_notifications" updates notification preferences (email toggles, frequency, sentiment threshold).

    • actionstringRequired

      Action to perform. "update_profile" updates profile fields. "update_notifications" updates notification preferences.

      One of: update_profile, update_notifications

    • firstNamestringOptional

      First name (action: update_profile)

    • lastNamestringOptional

      Last name (action: update_profile)

    • phonestringOptional

      Phone number (action: update_profile)

    • companystringOptional

      Company name (action: update_profile)

    • positionstringOptional

      Job title/position (action: update_profile)

    • biostringOptional

      Short bio, max 500 chars (action: update_profile)

    • websitestringOptional

      Personal/company website URL (action: update_profile)

    • countrystringOptional

      Country of residence (action: update_profile)

    • emailNotificationsbooleanOptional

      Master email toggle (action: update_notifications)

    • mentionAlertsbooleanOptional

      Alert on new mentions (action: update_notifications)

    • sentimentAlertsbooleanOptional

      Alert on sentiment changes (action: update_notifications)

    • dailyReportsbooleanOptional

      Daily report emails (action: update_notifications)

    • weeklyDigestbooleanOptional

      Weekly digest emails (action: update_notifications)

    • securityAlertsbooleanOptional

      Security-related alerts (action: update_notifications)

    • marketingEmailsbooleanOptional

      Marketing/promotional content (action: update_notifications)

    • interestedReplyAlertsbooleanOptional

      Alerts when interested leads reply (action: update_notifications)

    • productUpdatesbooleanOptional

      Product update notifications (action: update_notifications)

    • crisisAlertsbooleanOptional

      Crisis/emergency alerts (action: update_notifications)

    • campaignNotificationsbooleanOptional

      Campaign notification emails -- daily summary, errors, completions (action: update_notifications)

    • signalNotificationsbooleanOptional

      Signal engine notification emails -- source completed, messages ready to review, campaign launched (action: update_notifications)

    • emailFrequencystringOptional

      Email delivery frequency (action: update_notifications)

      One of: hourly, daily, weekly

    • sentimentThresholdstringOptional

      Sentiment filtering level (action: update_notifications)

      One of: all, negative, critical

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_brand_settings

    read only
    idempotent

    Get settings and configuration for the current brand. Returns brand info, platform toggles, monitored keywords, alerts, or social accounts based on type. Do NOT use for the basic brand list (use brandjet_list_brands). Do NOT use to change settings (use brandjet_manage_brand_settings).

    • typestringRequired

      Type of brand settings to retrieve. "overview" returns full brand config (name, description, website, logo, industry, monitoring status). "platforms" returns platform monitoring toggles. "keywords" returns monitored keywords. "alerts" returns alert settings (thresholds, crisis keywords, notification channels). "social_accounts" returns connected social account handles.

      One of: overview, platforms, keywords, alerts, social_accounts

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_brand_settings

    destructive

    Update settings for the current brand. action="update_info" updates brand name, description, website, industry, business type, target audience. action="update_platforms" toggles platform monitoring. action="update_alerts" updates alert thresholds and channels. action="update_social_accounts" updates social handles. action="toggle_monitoring" toggles monitoring on/off. Monitored keywords are read only here and must be changed in Manage Keywords.

    • actionstringRequired

      Action to perform. "update_info" updates basic brand info. "update_platforms" toggles platform monitoring. "update_alerts" updates alert thresholds and channels. "update_social_accounts" updates social media handles. "toggle_monitoring" toggles brand monitoring on/off.

      One of: update_info, update_platforms, update_alerts, update_social_accounts, toggle_monitoring

    • namestringOptional

      Brand name (action: update_info)

    • descriptionstringOptional

      Brand description (action: update_info)

    • websitestringOptional

      Brand website URL (action: update_info)

    • industrystringOptional

      Industry category (action: update_info)

    • businessTypestringOptional

      Business type, e.g. SaaS (action: update_info)

    • targetAudiencestring[]Optional

      Array of audience segments (action: update_info)

    • twitterbooleanOptional

      Toggle Twitter/X monitoring (action: update_platforms)

    • redditbooleanOptional

      Toggle Reddit monitoring (action: update_platforms)

    • newsbooleanOptional

      Toggle News monitoring (action: update_platforms)

    • youtubebooleanOptional

      Toggle YouTube monitoring (action: update_platforms)

    • linkedinbooleanOptional

      Toggle LinkedIn monitoring (action: update_platforms)

    • tiktokbooleanOptional

      Toggle TikTok monitoring (action: update_platforms)

    • llmbooleanOptional

      Toggle LLM/AI model monitoring (action: update_platforms)

    • sentimentThresholdValuenumberOptional

      Sentiment threshold from -1.0 to 1.0 (action: update_alerts)

    • volumeThresholdnumberOptional

      Volume threshold - mentions per hour (action: update_alerts)

    • crisisKeywordsstring[]Optional

      Keywords that trigger crisis alerts (action: update_alerts)

    • emailAlertsbooleanOptional

      Enable email alerts (action: update_alerts)

    • slackAlertsbooleanOptional

      Enable Slack alerts (action: update_alerts)

    • webhookUrlstringOptional

      Webhook URL for custom notifications (action: update_alerts)

    • socialTwitterstringOptional

      Twitter handle without @ (action: update_social_accounts)

    • socialLinkedinstringOptional

      LinkedIn company URL (action: update_social_accounts)

    • socialFacebookstringOptional

      Facebook page URL (action: update_social_accounts)

    • socialInstagramstringOptional

      Instagram handle without @ (action: update_social_accounts)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_brand_members

    destructive

    Manage team members for the current brand. action="list" lists all members. action="invite" invites by email with a role. action="change_role" changes a member's role. action="remove" removes a member. action="list_invitations" lists pending invitations. action="cancel_invitation" cancels an invitation.

    • actionstringRequired

      Action to perform. "list" lists all team members. "invite" invites a new member by email. "change_role" changes a member's role. "remove" removes a team member. "list_invitations" lists pending invitations. "cancel_invitation" cancels a pending invitation.

      One of: list, invite, change_role, remove, list_invitations, cancel_invitation

    • emailstringOptional

      Email of the person to invite (action: invite)

    • rolestringOptional

      Role to assign: "admin" or "viewer" (action: invite, change_role)

      One of: admin, viewer

    • memberIdstringOptional

      Member ID (action: change_role, remove)

    • invitationIdstringOptional

      Invitation ID (action: cancel_invitation)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_team_members

    read only
    idempotent

    List team members (userId, name, email, role, joinedAt) for the current brand. Use this to resolve user IDs returned by other tools — specifically Campaign.ownerId, Conversation.assignedToUserId, and Lead.assignedTo — into readable names and emails. Read-only; use brandjet_manage_brand_members to invite, change roles, or remove members.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_email_warmup

    destructive

    Manage email warmup to build sender reputation. Warmup gradually increases sending volume by exchanging emails with other warmup accounts. Actions: enable warmup (action="enable"), pause warmup (action="disable", keeps history and ramp progress so enabling again resumes where it left off), bulk enable (action="bulk_enable"), bulk pause (action="bulk_disable"). Do NOT use for email account settings like sending limits or signatures (use brandjet_manage_email_accounts instead).

    • actionstringRequired

      Action to perform. "enable" enables warmup for a single account and resumes its previous ramp progress if it was paused. "disable" pauses warmup for a single account and keeps its history and ramp progress. "bulk_enable" enables warmup for multiple accounts. "bulk_disable" pauses warmup for multiple accounts.

      One of: enable, disable, bulk_enable, bulk_disable

    • accountIdstringOptional

      Email account ID (required for enable, disable)

    • accountIdsstring[]Optional

      Email account IDs (required for bulk_enable, bulk_disable)

    • maxDailyCountintegerOptional

      Maximum warmup emails per day (default: 40). Used with enable/bulk_enable.

    • dailyIncrementintegerOptional

      Number of additional warmup emails added per day during ramp-up (default: 2). Used with enable/bulk_enable.

    • startCountintegerOptional

      Number of warmup emails on day 1 (default: 5). Used with enable/bulk_enable.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_search_lead_database

    destructive
    open world

    Search BrandJet's lead database for new prospects by job title, seniority, department, location, company, industry, headcount, revenue, funding stage, and technology. Returns 25 people per page with total, totalPages, and hasMore; pages 1 to 3 are free and later pages cost 1 credit per result returned. Each result has id, fullName, jobTitle, seniority, company, companyDomain, industry, location, linkedinUrl, and emailAvailable/phoneAvailable flags; emails and phone numbers are not included. Results are NOT in your lead lists yet and result ids are external lead database ids, not saved BrandJet lead UUIDs. Call brandjet_get_search_filters to see every filter key. Do NOT use to query leads already in your lists (use brandjet_get_leads or brandjet_advanced_filter_leads). Do NOT pass these result ids to brandjet_enrich_leads. To save, export, or bulk reveal contact data from these results, use brandjet_manage_search_results; to reveal one email, use brandjet_find_contact_info with reveal_search_email.

    • jobTitlestring[]Optional

      Current job title or titles, matched as contains (e.g. ["CTO", "Chief Technology Officer"]). Combined with filters.jobTitles.

    • companystring[]Optional

      Current company name or names. Combined with filters.companyNames.

    • industrystring[]Optional

      LinkedIn industry name or names (e.g. "Software Development"). Combined with filters.industries.

    • countrystring[]Optional

      Country or countries where the person is based (e.g. "United States"). Combined with filters.personLocations.

    • filtersobjectOptional

      Lead search filters. Strict keys: unknown keys are rejected. A search needs at least one include filter; exclude keys alone are rejected. Locations are real place names ("United States", "California, United States", "Austin, Texas") and technologies are product names ("HubSpot", "Salesforce"). Call brandjet_get_search_filters to see every accepted key with its type, allowed values and examples.

    • filters.jobTitlesstring[]Optional

      Current job title or titles, matched as contains (e.g. ["CTO", "Chief Technology Officer"]). Combined with filters.jobTitles.

    • filters.excludeJobTitlesstring[]Optional
    • filters.senioritiesstring[]Optional
    • filters.departmentsstring[]Optional
    • filters.personLocationsstring[]Optional

      Country or countries where the person is based (e.g. "United States"). Combined with filters.personLocations.

    • filters.excludePersonLocationsstring[]Optional
    • filters.yearsOfExperienceMinintegerOptional
    • filters.yearsOfExperienceMaxintegerOptional
    • filters.personNamesstring[]Optional
    • filters.verifiedEmailOnlybooleanOptional
    • filters.verifiedMobileOnlybooleanOptional
    • filters.companyNamesstring[]Optional

      Current company name or names. Combined with filters.companyNames.

    • filters.excludeCompanyNamesstring[]Optional
    • filters.companyDomainsstring[]Optional
    • filters.excludeCompanyDomainsstring[]Optional
    • filters.industriesstring[]Optional

      LinkedIn industry name or names (e.g. "Software Development"). Combined with filters.industries.

    • filters.excludeIndustriesstring[]Optional
    • filters.employeeCountMinintegerOptional
    • filters.employeeCountMaxintegerOptional
    • filters.revenueMinstringOptional

      One of: <100K, 100K, 500K, 1M, 5M, 10M, 25M, 50M, 100M, 250M, 500M, 1B, 5B, 10B+

    • filters.revenueMaxstringOptional

      One of: <100K, 100K, 500K, 1M, 5M, 10M, 25M, 50M, 100M, 250M, 500M, 1B, 5B, 10B+

    • filters.fundingStagesstring[]Optional
    • filters.technologiesstring[]Optional
    • filters.excludeTechnologiesstring[]Optional
    • filters.companyLocationsstring[]Optional
    • filters.excludeCompanyLocationsstring[]Optional
    • filters.foundedMinintegerOptional
    • filters.foundedMaxintegerOptional
    • filters.companyKeywordsstring[]Optional
    • filters.naicsCodesinteger[]Optional
    • filters.sicCodesinteger[]Optional
    • pageintegerOptional

      Page number (default: 1). Each page has 25 results. Pages 1 to 3 are free; later pages cost 1 credit per result returned.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_find_contact_info

    destructive
    open world

    Find contact information for a specific known person. Costs credits per lookup; a lookup that returns nothing is refunded automatically. "find_email" finds an email by first name, last name, and company domain (2 credits). "linkedin_to_email" finds an email from a LinkedIn profile URL (2 credits). "find_phone" finds a phone number by email or LinkedIn URL (50 credits; check balance first). "reveal_search_email" finds the email of one result from a brandjet_search_lead_database search on this brand in the last 6 hours; pass that result row as person, and only its id is read (2 credits). If the result is no longer available, run the search again. Do NOT use to search for new prospects (use brandjet_search_lead_database). Do NOT use for bulk contact finding (use brandjet_enrich_leads with bulk_find_emails or bulk_find_phones for saved leads, or brandjet_manage_search_results with reveal for search results).

    • actionstringRequired

      Action to perform. "find_email" finds an email by name + company domain (2 credits). "linkedin_to_email" finds an email from a LinkedIn profile URL (2 credits). "find_phone" finds a phone number by email or LinkedIn URL (50 credits). "reveal_search_email" finds the email of one brandjet_search_lead_database result passed as person (2 credits). Lookups that find nothing are refunded.

      One of: find_email, linkedin_to_email, find_phone, reveal_search_email

    • firstNamestringOptional

      Person's first name (required for find_email)

    • lastNamestringOptional

      Person's last name (required for find_email)

    • domainstringOptional

      Company domain, e.g. "acme.com" (required for find_email)

    • linkedinProfilestringOptional

      LinkedIn profile URL (required for linkedin_to_email, optional for find_phone)

    • emailstringOptional

      Email address (optional for find_phone)

    • personobjectOptional

      One result row from a brandjet_search_lead_database search on this brand in the last 6 hours (required for reveal_search_email). Pass the row as returned, or { id }; only the id is read, and the server reads the row from the search that returned it.

    • person.idstringRequired

      The "id" of the brandjet_search_lead_database result

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_enrich_leads

    destructive
    open world

    Enrich existing leads already in your lists with profile data or find contact information in bulk via background jobs. All leadId/leadIds values must be saved BrandJet lead UUIDs. "enrich_lead" enriches a single lead with full profile data via BrandJet's enrichment engine (1 credit). "enrich_list" enriches all leads in a list via a background job (1 credit/lead). "bulk_find_emails" finds emails for multiple saved leads via background job (2 credits per lead where an email is found; misses are refunded; leads that already have an email are skipped and never charged). "bulk_find_phones" finds phone numbers for multiple saved leads via background job (50 credits per lead where a phone is found; misses are refunded - check balance first, the full amount is reserved up front). Do NOT use for single contact lookups (use brandjet_find_contact_info). Do NOT use for external lead database search results (use brandjet_manage_search_results).

    • actionstringRequired

      Action to perform. "enrich_lead" enriches a single lead with full profile data (1 credit). "enrich_list" enriches all leads in a list via background job (1 credit/lead). "bulk_find_emails" finds emails for multiple leads via background job (2 credits/lead; leads that already have an email are skipped). "bulk_find_phones" finds phone numbers for multiple leads via background job (50 credits/lead). Only use this for leads already saved in BrandJet.

      One of: enrich_lead, enrich_list, bulk_find_emails, bulk_find_phones

    • leadIdstringOptional

      Lead ID to enrich (required for enrich_lead)

    • leadListIdstringOptional

      Lead list ID to enrich all leads in (required for enrich_list)

    • leadIdsstring[]Optional

      Array of saved BrandJet lead UUIDs for bulk operations (required for bulk_find_emails, bulk_find_phones). Do not pass external ids from brandjet_search_lead_database.

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_search_results

    destructive

    Import, export, or bulk reveal lead database search results returned by brandjet_search_lead_database. "import" saves the search results named in resultIds to a lead list (free). "export" exports search results with optional email/phone lookups as a background job (1 credit/lead base, +2 with emails, +50 with phones); scope "all" exports every result matching filters (up to 25,000), "current_page" and "selected" export the results named in resultIds. "reveal" finds emails and/or phones for the search results passed as people in one background job (2 credits per email, 50 per phone; unused credits are refunded when the job completes). Import, export and reveal read only each result's id, passed as the id or as the row returned: the server reads each row from the search that returned it, for 6 hours and only on the brand that ran it. If an id is no longer available, run the search again. Export destinations: CSV download, lead list, or campaign. Track jobs with brandjet_get_enrichment_jobs. Use this instead of brandjet_enrich_leads when the rows came from lead database search results.

    • actionstringRequired

      Action to perform. "import" saves the search results named in resultIds to a lead list (free). "export" exports search results with optional email/phone lookups as a background job (1 credit/lead base, +2 with emails, +50 with phones). "reveal" finds emails and/or phones for the search results passed as people in one background job (2 credits per email, 50 per phone). Use this for results returned by brandjet_search_lead_database.

      One of: import, export, reveal

    • resultIdsstring | object[]Optional

      The brandjet_search_lead_database results to save (required for import) or to export with scope "current_page" or "selected", up to 500. Pass each result's "id", or the result rows as returned; only the id is read, and the server reads each row from the search that returned it. Ids stay valid for 6 hours, and only for the brand that ran the search; after that, run the search again.

    • resultIds[].idstringRequired

      The "id" of the brandjet_search_lead_database result

    • peopleobject[]Optional

      Result rows from a brandjet_search_lead_database search on this brand in the last 6 hours to reveal (required for reveal, up to 500). Pass each row as returned, or { id }; only the id is read, and the server reads each row from the search that returned it. These ids are not saved BrandJet lead UUIDs.

    • people[].idstringRequired

      The "id" of the brandjet_search_lead_database result

    • fieldsstring[]Optional

      Fields to reveal for people. Use ["email"], ["phone"], or both.

      One of: email, phone

    • listIdstringOptional

      Existing lead list ID to import/export into

    • newListNamestringOptional

      Name for a new lead list to create for import/export

    • scopestringOptional

      Export scope (required for export). "all" exports every result matching filters; "current_page" and "selected" export the results named in resultIds.

      One of: all, current_page, selected

    • filtersobjectOptional

      Search filters to export with scope "all", in the same format as brandjet_search_lead_database filters. Strict keys: unknown keys are rejected. Call brandjet_get_search_filters to see every accepted key with its type, allowed values and examples.

    • filters.jobTitlesstring[]Optional
    • filters.excludeJobTitlesstring[]Optional
    • filters.senioritiesstring[]Optional
    • filters.departmentsstring[]Optional
    • filters.personLocationsstring[]Optional
    • filters.excludePersonLocationsstring[]Optional
    • filters.yearsOfExperienceMinintegerOptional
    • filters.yearsOfExperienceMaxintegerOptional
    • filters.personNamesstring[]Optional
    • filters.verifiedEmailOnlybooleanOptional
    • filters.verifiedMobileOnlybooleanOptional
    • filters.companyNamesstring[]Optional
    • filters.excludeCompanyNamesstring[]Optional
    • filters.companyDomainsstring[]Optional
    • filters.excludeCompanyDomainsstring[]Optional
    • filters.industriesstring[]Optional
    • filters.excludeIndustriesstring[]Optional
    • filters.employeeCountMinintegerOptional
    • filters.employeeCountMaxintegerOptional
    • filters.revenueMinstringOptional

      One of: <100K, 100K, 500K, 1M, 5M, 10M, 25M, 50M, 100M, 250M, 500M, 1B, 5B, 10B+

    • filters.revenueMaxstringOptional

      One of: <100K, 100K, 500K, 1M, 5M, 10M, 25M, 50M, 100M, 250M, 500M, 1B, 5B, 10B+

    • filters.fundingStagesstring[]Optional
    • filters.technologiesstring[]Optional
    • filters.excludeTechnologiesstring[]Optional
    • filters.companyLocationsstring[]Optional
    • filters.excludeCompanyLocationsstring[]Optional
    • filters.foundedMinintegerOptional
    • filters.foundedMaxintegerOptional
    • filters.companyKeywordsstring[]Optional
    • filters.naicsCodesinteger[]Optional
    • filters.sicCodesinteger[]Optional
    • maxRowsintegerOptional

      Maximum rows to export with scope "all" (default: all matching results, capped at 25,000). Credits are reserved upfront for the estimated row count and unused credits are refunded when the job completes.

    • includeEmailsbooleanOptional

      Add email addresses to exported leads (+2 credits/lead)

    • includePhonesbooleanOptional

      Add phone numbers to exported leads (+50 credits/lead)

    • destinationstringOptional

      Export destination (required for export)

      One of: csv, list, campaign

    • campaignIdstringOptional

      Existing campaign ID when destination is "campaign"

    • newCampaignNamestringOptional

      Name for a new campaign when destination is "campaign"

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_search_filters

    read only
    idempotent

    Return the full catalog of filter keys accepted in the filters object of brandjet_search_lead_database, brandjet_manage_search_results (export), and brandjet_manage_saved_searches. Use this BEFORE building a lead database search. Grouped by section (person, location, company, industry, technology, funding). Each entry includes the key name, type, allowed values or examples, and notes. Pass groupId to narrow the response to a single section.

    • groupIdstringOptional

      Optional group id to return only filters in that group ("person", "location", "company", "industry", "technology", "funding").

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_enrichment_credits

    read only
    idempotent

    Check enrichment credit balance, view purchasable credit tiers, or view credit usage history. Credit costs: person enrichment (1), email finder (2), LinkedIn-to-email (2), phone finder (50), search lead export (1). Lookups that find nothing are refunded, so only successful reveals cost credits. Always check balance before suggesting expensive operations.

    • actionstringRequired

      Action to perform. "balance" returns current credit balance. "tiers" lists purchasable credit packs with pricing. "history" returns paginated credit usage history.

      One of: balance, tiers, history

    • pageintegerOptional

      Page number for history (default: 1)

    • limitintegerOptional

      Items per page for history (default: 25)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_enrichment_jobs

    read only
    idempotent

    View enrichment background jobs and their progress. "list" shows all jobs for the brand. "get" shows details for a specific job including progress (processed/total items, credits used). "lead_history" shows all enrichment operations performed on a specific lead.

    • actionstringRequired

      Action to perform. "list" returns all enrichment jobs for the brand. "get" returns a specific job with progress details. "lead_history" returns enrichment history for a specific lead.

      One of: list, get, lead_history

    • jobIdstringOptional

      Enrichment job ID (required for get)

    • leadIdstringOptional

      Lead ID to get enrichment history for (required for lead_history)

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_manage_saved_searches

    Manage saved lead database searches. Save frequently used search filters for quick reuse. Each saved search has a name and filters in the same format as brandjet_search_lead_database filters.

    • actionstringRequired

      Action to perform. "list" returns all saved searches. "create" saves a new search configuration. "update" modifies a saved search. "delete" removes a saved search.

      One of: list, create, update, delete

    • savedSearchIdstringOptional

      Saved search ID (required for update, delete)

    • namestringOptional

      Name for the saved search (required for create, optional for update)

    • filtersobjectOptional

      Search filters to save, in the same format as brandjet_search_lead_database filters (required for create, optional for update). Strict keys: unknown keys are rejected.

    • filters.jobTitlesstring[]Optional
    • filters.excludeJobTitlesstring[]Optional
    • filters.senioritiesstring[]Optional
    • filters.departmentsstring[]Optional
    • filters.personLocationsstring[]Optional
    • filters.excludePersonLocationsstring[]Optional
    • filters.yearsOfExperienceMinintegerOptional
    • filters.yearsOfExperienceMaxintegerOptional
    • filters.personNamesstring[]Optional
    • filters.verifiedEmailOnlybooleanOptional
    • filters.verifiedMobileOnlybooleanOptional
    • filters.companyNamesstring[]Optional
    • filters.excludeCompanyNamesstring[]Optional
    • filters.companyDomainsstring[]Optional
    • filters.excludeCompanyDomainsstring[]Optional
    • filters.industriesstring[]Optional
    • filters.excludeIndustriesstring[]Optional
    • filters.employeeCountMinintegerOptional
    • filters.employeeCountMaxintegerOptional
    • filters.revenueMinstringOptional

      One of: <100K, 100K, 500K, 1M, 5M, 10M, 25M, 50M, 100M, 250M, 500M, 1B, 5B, 10B+

    • filters.revenueMaxstringOptional

      One of: <100K, 100K, 500K, 1M, 5M, 10M, 25M, 50M, 100M, 250M, 500M, 1B, 5B, 10B+

    • filters.fundingStagesstring[]Optional
    • filters.technologiesstring[]Optional
    • filters.excludeTechnologiesstring[]Optional
    • filters.companyLocationsstring[]Optional
    • filters.excludeCompanyLocationsstring[]Optional
    • filters.foundedMinintegerOptional
    • filters.foundedMaxintegerOptional
    • filters.companyKeywordsstring[]Optional
    • filters.naicsCodesinteger[]Optional
    • filters.sicCodesinteger[]Optional
    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_find_ui_element

    read only
    idempotent

    Find a specific UI element on the current page. Given a natural language query and the list of available UI elements, identify the best matching element and return its ID. Use this when the user asks "where is X?", "find the X button", "show me how to X", or any request to locate something on the interface.

    • querystringRequired

      Natural language query describing the UI element the user is looking for, e.g. "create campaign button", "inbox", "settings page"

    • availableElementsobject[]Required

      List of UI elements currently visible on the page

    • availableElements[].idstringRequired

      The data-artemis-id of the element

    • availableElements[].labelstringRequired

      Human-readable label of the element

    • availableElements[].descriptionstringOptional

      Optional description of the element

    • brandIdstringOptional

      Brand id for this call only (see brandjet_list_brands). Defaults to the session brand.

    brandjet_get_tool_run

    read only
    idempotent

    Collect the result of a long tool call. A call that is still working after 45 seconds answers with status "running" and a runId instead of its result, and keeps working in the background. Call this tool with that runId about every 15 seconds. It answers with one of three statuses. "running": the call is still working, so ask again later. "completed": the call has finished, and the rest of this answer is exactly what that call returned, including an error if it failed. "not_found": this login and brand have no run with that runId, because it never existed, finished more than 24 hours ago, or was cut off by a server restart; only then make the original call again. Don't repeat the original call while it runs: an identical call answers with the same runId.

    • runIdstringRequired

      The runId from a call that answered with status "running".

    • brandIdstringOptional

      The brandId you passed on that call, if you passed one. Leave it out otherwise.