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.
The same list is available as JSON and, with the REST endpoints, in llms-full.txt.
In the order the server lists them.
brandjet_list_brandsList 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_brandSwitch 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.
brandIdstringRequiredBrand ID to switch to. Must be one of the IDs returned by brandjet_list_brands.
brandjet_create_brandCreate 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.
namestringRequiredBrand name, as its customers know it (1-255 characters).
websitestringRequiredBrand website, for example https://example.com. The name and the website domain become the brand keywords.
platformsstring[]OptionalPlatforms to monitor once monitoring is on. Defaults to twitter, reddit, youtube, news and linkedin.
One of: twitter, reddit, youtube, news, linkedin, tiktok
brandjet_create_campaignCreate 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.
namestringRequiredCampaign name (e.g., "Summer Outreach 2024")
typestringRequiredCampaign 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
descriptionstringOptionalCampaign description
prioritystringOptionalPriority level (default: medium)
One of: low, medium, high, urgent
targetAudiencestringOptionalDescription of target audience
scheduledStartAtstringOptionalScheduled start date-time (ISO 8601)
scheduledEndAtstringOptionalScheduled end date-time (ISO 8601)
timezonestringOptionalTimezone for sending schedule (e.g., "America/New_York")
sendingDaysstring[]OptionalDays of week to send on
One of: monday, tuesday, wednesday, thursday, friday, saturday, sunday
sendingTimeStartstringOptionalDaily sending window start (HH:MM format, e.g., "09:00")
sendingTimeEndstringOptionalDaily sending window end (HH:MM format, e.g., "17:00")
maxNewLeadsPerDayintegerOptionalMaximum new leads to contact per day
prioritizeNewLeadsbooleanOptionalWhether to prioritize new leads (default: false)
respectTimezonebooleanOptionalWhether to respect lead timezone for sending (default: false)
trackOpensbooleanOptionalTrack email opens (default: true)
trackClicksbooleanOptionalTrack email link clicks (default: true)
trackUnsubscribesbooleanOptionalTrack unsubscribe events (default: false)
includeUnsubscribeLinkbooleanOptionalAppend 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)
gdprCompliantbooleanOptionalAdd GDPR compliance footer and unsubscribe handling to every email in this campaign (default: false)
canSpamCompliantbooleanOptionalAdd CAN-SPAM compliance footer and unsubscribe handling to every email in this campaign (default: false)
stopSendingTriggerstringOptionalStop sending to a lead when this event occurs (default: reply)
One of: reply, click, open, bounce
enableProviderMatchingbooleanOptionalMatch email provider (e.g., Outlook to Outlook) (default: true)
workflowsobject[]OptionalWorkflow 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[].namestringRequiredWorkflow name (e.g., "Main Sequence")
workflows[].descriptionstringOptionalworkflows[].nodesobject[]RequiredWorkflow 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[].nodeIdstringRequiredUnique node identifier within the workflow (e.g., "node-1", "start-1")
workflows[].nodes[].labelstringRequiredDisplay label for the node
workflows[].nodes[].typestringRequiredNode 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[].statusstringOptionalSet to "configured" when the node has all required configurations filled in. Default: action_needed.
One of: action_needed, configured, draft
workflows[].nodes[].channelstringOptionalRequired 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[].positionXnumberOptionalCanvas X position for UI layout
workflows[].nodes[].positionYnumberOptionalCanvas Y position for UI layout
workflows[].nodes[].titlestringOptionalAlternative display title
workflows[].nodes[].sendWhenstringOptionalIMPORTANT: 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[].delayValuenumberOptionalHow long to wait before executing this node (used when sendWhen="delay")
workflows[].nodes[].delayUnitstringOptionalTime unit for delayValue (minutes, hours, days, weeks)
One of: minutes, hours, days, weeks
workflows[].nodes[].configurationsobject[]OptionalNode-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[].configKeystringRequiredConfiguration 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[].configValuestringOptionalConfiguration 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[].dataTypestringOptionalOptional data type hint
workflows[].nodes[].variantDistributionstringOptionalEnables 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[].variantWinningMetricstringOptionalMetric 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[].variantMinSampleSizeintegerOptionalMinimum sends per variant before a winner can be declared under "auto_optimize". Default: 100.
workflows[].nodes[].variantsobject[]OptionalA/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[].variantKeystringRequiredSingle uppercase letter identifying the variant ("A", "B", "C", ...). Must be unique within the node. Use "A" for the control.
workflows[].nodes[].variants[].weightnumberOptionalShare 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[].isControlbooleanOptionalMark exactly one variant per node as the control (baseline). Default: false.
workflows[].nodes[].variants[].senderAccountIdstringOptionalOptional: 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[].senderAccountTypestringOptionalType 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[].delayValuenumberOptionalOptional: override the node-level delayValue for this variant only (to test send timing).
workflows[].nodes[].variants[].delayUnitstringOptionalTime unit for the variant delayValue override
One of: minutes, hours, days, weeks
workflows[].nodes[].variants[].configsobject[]OptionalVariant-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[]RequiredEdges connecting nodes by their nodeId.
workflows[].edges[].edgeIdstringRequiredUnique edge identifier within the workflow
workflows[].edges[].sourceNodeIdstringRequiredSource node nodeId
workflows[].edges[].targetNodeIdstringRequiredTarget node nodeId
workflows[].edges[].labelstringOptionalEdge 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[].conditionstringOptionalCondition logic expression
workflows[].edges[].isActivebooleanOptionalWhether this edge is active (default: true)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_campaignsGet 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.
campaignIdstringOptionalCampaign ID. If provided, returns full details. If omitted, lists all campaigns for the current brand.
includeWorkflowbooleanOptionalInclude workflow definition with nodes and edges (only when campaignId is provided, default: false)
includeVariablesbooleanOptionalInclude 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)
includeLeadStatsbooleanOptionalInclude lead statistics by channel (only when campaignId is provided, default: false)
includeAccountsbooleanOptionalInclude linked sending accounts (only when campaignId is provided, default: false)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_campaign_analyticsGet 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.
campaignIdstringOptionalOptional campaign ID. Omit to aggregate across every campaign in the current brand workspace.
timeframestringOptionalTime 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
dateFromstringOptionalCustom start date in YYYY-MM-DD or ISO format. Only needed when timeframe is custom.
dateTostringOptionalCustom end date in YYYY-MM-DD or ISO format, inclusive. Only needed when timeframe is custom.
channelstringOptionalOptional channel filter. Use "email" for email-specific send counts, "linkedin" for LinkedIn outreach, etc.
One of: email, linkedin, twitter, instagram, whatsapp, telegram, slack, sms
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_list_campaign_resourcesList 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.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_configure_campaignConfigure 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).
campaignIdstringRequiredCampaign ID to configure
settingsobjectOptionalCampaign-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.verifiedOnlybooleanOptionalWhen 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.namestringOptionalRename the campaign
settings.descriptionstringOptionalCampaign description
settings.prioritystringOptionalPriority level
One of: low, medium, high, urgent
settings.targetAudiencestringOptionalDescription of target audience
settings.maxNewLeadsPerDayintegerOptionalDaily cap on how many new leads the campaign starts contacting. Change this here; it does not require creating a new campaign.
settings.prioritizeNewLeadsbooleanOptionalPrioritise new leads over follow-ups when the daily cap is reached
settings.timezonestringOptionalTimezone for the sending schedule (e.g., "America/New_York")
settings.sendingDaysstring[]OptionalDays of week to send on
One of: monday, tuesday, wednesday, thursday, friday, saturday, sunday
settings.sendingTimeStartstringOptionalDaily sending window start (HH:MM, e.g., "09:00")
settings.sendingTimeEndstringOptionalDaily sending window end (HH:MM, e.g., "17:00")
settings.respectTimezonebooleanOptionalRespect each lead timezone when sending
settings.trackOpensbooleanOptionalTrack email opens
settings.trackClicksbooleanOptionalTrack email link clicks
settings.trackUnsubscribesbooleanOptionalTrack unsubscribe events
settings.includeUnsubscribeLinkbooleanOptionalAppend 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.gdprCompliantbooleanOptionalAdd GDPR compliance footer and unsubscribe handling to every email in this campaign
settings.canSpamCompliantbooleanOptionalAdd CAN-SPAM compliance footer and unsubscribe handling to every email in this campaign
settings.stopSendingTriggerstringOptionalStop sending to a lead when this event occurs
One of: reply, click, open, bounce
settings.enableProviderMatchingbooleanOptionalMatch email provider (e.g., Outlook to Outlook)
settings.scheduledStartAtstringOptionalScheduled start date-time (ISO 8601)
settings.scheduledEndAtstringOptionalScheduled end date-time (ISO 8601)
leadsobjectOptionalLeads to add to the campaign. Multiple methods can be combined in one call.
leads.fromListIdsstring[]OptionalAdd leads from these lead list IDs
leads.qualifiedOnlybooleanOptionalWith fromListIds: add only leads the AI qualification marked as qualified (customVariables.qualification_status = "qualified")
leads.byIdsstring[]OptionalAdd specific lead IDs directly
leads.manualobject[]OptionalManually 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[].namestringOptionalLead name
leads.manual[].emailstringOptionalLead email address
leads.manual[].phoneNumberstringOptionalLead phone number
leads.manual[].linkedinProfileUrlstringOptionalLinkedIn profile URL
leads.manual[].twitterProfileUrlstringOptionalTwitter/X profile URL
leads.manual[].instagramProfileUrlstringOptionalInstagram profile URL
leads.manual[].customVariablesobjectOptionalCustom personalization variables as key-value pairs
accountsobjectOptionalSending accounts to link to the campaign. Account selection MUST be operator-confirmed. Pass accounts.confirmed: true to apply changes.
accounts.accountIdsstring[]OptionalSpecific email account or integration IDs to link
accounts.selectAllbooleanOptionalSelect all brand accounts matching the type/provider filters
accounts.typestringOptionalFilter accounts by type (used with selectAll)
One of: email, social
accounts.providerstringOptionalFilter accounts by provider (used with selectAll)
One of: google, outlook, smtp, twitter, linkedin, instagram, whatsapp
accounts.replacebooleanOptionalReplace existing accounts (true) or merge with existing (false). Default: true
accounts.confirmedbooleanOptionalRequired 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.
workflowobjectOptionalReplace the campaign workflow entirely. The full workflow (nodes + edges) must be provided.
workflow.namestringRequiredWorkflow name (e.g., "Main Sequence")
workflow.descriptionstringOptionalworkflow.nodesobject[]RequiredWorkflow 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[].nodeIdstringRequiredUnique node identifier within the workflow (e.g., "node-1", "start-1")
workflow.nodes[].labelstringRequiredDisplay label for the node
workflow.nodes[].typestringRequiredNode 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[].statusstringOptionalSet to "configured" when the node has all required configurations filled in. Default: action_needed.
One of: action_needed, configured, draft
workflow.nodes[].channelstringOptionalRequired 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[].positionXnumberOptionalCanvas X position for UI layout
workflow.nodes[].positionYnumberOptionalCanvas Y position for UI layout
workflow.nodes[].titlestringOptionalAlternative display title
workflow.nodes[].sendWhenstringOptionalIMPORTANT: 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[].delayValuenumberOptionalHow long to wait before executing this node (used when sendWhen="delay")
workflow.nodes[].delayUnitstringOptionalTime unit for delayValue (minutes, hours, days, weeks)
One of: minutes, hours, days, weeks
workflow.nodes[].configurationsobject[]OptionalNode-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[].configKeystringRequiredConfiguration 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[].configValuestringOptionalConfiguration 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[].dataTypestringOptionalOptional data type hint
workflow.nodes[].variantDistributionstringOptionalEnables 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[].variantWinningMetricstringOptionalMetric 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[].variantMinSampleSizeintegerOptionalMinimum sends per variant before a winner can be declared under "auto_optimize". Default: 100.
workflow.nodes[].variantsobject[]OptionalA/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[].variantKeystringRequiredSingle uppercase letter identifying the variant ("A", "B", "C", ...). Must be unique within the node. Use "A" for the control.
workflow.nodes[].variants[].weightnumberOptionalShare 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[].isControlbooleanOptionalMark exactly one variant per node as the control (baseline). Default: false.
workflow.nodes[].variants[].senderAccountIdstringOptionalOptional: 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[].senderAccountTypestringOptionalType 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[].delayValuenumberOptionalOptional: override the node-level delayValue for this variant only (to test send timing).
workflow.nodes[].variants[].delayUnitstringOptionalTime unit for the variant delayValue override
One of: minutes, hours, days, weeks
workflow.nodes[].variants[].configsobject[]OptionalVariant-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[]RequiredEdges connecting nodes by their nodeId.
workflow.edges[].edgeIdstringRequiredUnique edge identifier within the workflow
workflow.edges[].sourceNodeIdstringRequiredSource node nodeId
workflow.edges[].targetNodeIdstringRequiredTarget node nodeId
workflow.edges[].labelstringOptionalEdge 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[].conditionstringOptionalCondition logic expression
workflow.edges[].isActivebooleanOptionalWhether this edge is active (default: true)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_campaign_actionPerform 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).
campaignIdstringRequiredCampaign ID
actionstringRequiredAction 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
selectAllbooleanOptionalLaunch for all campaign leads. Defaults to false when leadIds is given and to true otherwise. Only used with "launch" action.
leadIdsstring[]OptionalSpecific 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.
scheduledStartAtstringOptionalISO 8601 datetime to schedule the launch. If omitted, launches immediately. Only used with "launch" action.
timezonestringOptionalTimezone for the sending schedule (e.g., "America/New_York"). Only used with "launch" action.
dryRunbooleanOptionalIf 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.
confirmedbooleanOptionalRequired 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.
acknowledgeDeliverabilityRiskbooleanOptionalRequired 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.
acknowledgeWarmupRiskbooleanOptionalRequired 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.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_campaign_lead_analyticsGet 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.
campaignIdstringRequiredCampaign ID
pageintegerOptionalPage number (default: 1)
limitintegerOptionalResults per page (default: 25, max: 50)
searchstringOptionalSearch leads by name or email
statusstringOptionalFilter by execution status
One of: pending, running, completed, failed, cancelled, paused
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_campaign_executionsGet 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).
campaignIdstringRequiredCampaign ID
pageintegerOptionalPage number (default: 1)
limitintegerOptionalResults per page (default: 50, max: 100)
statusstringOptionalFilter by execution step status
One of: pending, processing, completed, failed, skipped, waiting_follow_acceptance, waiting_connection_acceptance
channelstringOptionalFilter by channel
One of: email, linkedin, twitter, instagram, whatsapp, telegram, sms
nodeIdstringOptionalFilter by workflow node ID
leadIdstringOptionalFilter by lead ID
sinceDatestringOptionalISO 8601 date to filter steps scheduled/executed after this date
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_create_mention_to_outreach_workflowWire 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.
listeningQuerystringRequiredMention query or topic to monitor, e.g. "founders complaining about Hootsuite".
platformsstring[]OptionalPlatform 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
filtersobjectOptionalOptional sentiment and intent filters.
filters.sentimentTypesstring[]OptionalOnly trigger for these sentiment labels.
One of: positive, negative, neutral, mixed
filters.intentTypesstring[]OptionalOnly trigger for these mention intent labels.
One of: buyer, buying_signal, switching, pain_point, seller, neutral, general_discussion, self_promotion
filters.buyerIntentOnlybooleanOptionalShortcut for buyer, buying_signal, switching, and pain_point intents.
filters.onlyNeedsResponsebooleanOptionalWhen true, fetched mentions must still be marked needs_response before enrollment.
campaignIdstringOptionalExisting campaign ID to enroll matched mention authors into. Mutually exclusive with campaign.
campaignobjectOptionalInline campaign spec to create and wire. Mutually exclusive with campaignId.
campaign.namestringRequiredCampaign name to create.
campaign.descriptionstringOptionalOptional campaign description.
campaign.typestringOptionalCampaign type. Defaults to outreach.
One of: email_sequence, outreach, nurture, sales
campaign.prioritystringOptionalCampaign priority. Defaults to medium.
One of: low, medium, high, urgent
campaign.targetAudiencestringOptionalTarget audience description.
campaign.subjectstringOptionalDefault email subject when sequence is omitted.
campaign.messageTemplatestringOptionalDefault first-step message when sequence is omitted.
campaign.channelstringOptionalDefault outreach channel for generated sequence. Defaults to email.
One of: email, linkedin, twitter, instagram, whatsapp, telegram
campaign.sequenceobject[]OptionalOptional sequence steps. If omitted, one step is generated from messageTemplate.
campaign.sequence[].channelstringOptionalOutbound channel for this step. Defaults to the campaign channel.
One of: email, linkedin, twitter, instagram, whatsapp, telegram
campaign.sequence[].subjectstringOptionalEmail subject for email steps.
campaign.sequence[].messageTemplatestringRequiredMessage copy. Mention variables are available as {{custom.mention_content}}, {{custom.mention_platform}}, and {{custom.mention_url}}.
campaign.sequence[].delayValueintegerOptionalDelay before this step. Omit for the first immediate step.
campaign.sequence[].delayUnitstringOptionalDelay unit for delayValue.
One of: minutes, hours, days, weeks
campaign.sendingAccountsobjectOptionalSending accounts to link to the new campaign.
campaign.sendingAccounts.accountIdsstring[]OptionalSpecific email account or integration IDs to link.
campaign.sendingAccounts.selectAllbooleanOptionalWhen true, link every healthy account matching type/provider.
campaign.sendingAccounts.typestringOptionalFilter for selectAll.
One of: email, social
campaign.sendingAccounts.providerstringOptionalProvider filter for selectAll.
One of: google, outlook, smtp, twitter, linkedin, instagram, whatsapp, reddit, youtube, telegram
campaign.sendingAccounts.replacebooleanOptionalReplace existing sending accounts. Defaults to true.
campaign.scheduleobjectOptionalOptional sending schedule.
campaign.schedule.timezonestringOptionalIANA timezone, e.g. America/New_York.
campaign.schedule.sendingDaysstring[]OptionalDays allowed for sending.
One of: monday, tuesday, wednesday, thursday, friday, saturday, sunday
campaign.schedule.sendingTimeStartstringOptionalDaily sending window start, HH:MM.
campaign.schedule.sendingTimeEndstringOptionalDaily sending window end, HH:MM.
campaign.schedule.maxNewLeadsPerDayintegerOptionalMaximum new leads to contact per day.
campaign.initialStatusstringOptionalInitial campaign state after creation. Defaults to paused for review.
One of: draft, paused
approvalModestringOptionalControls 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
enrichAuthorsbooleanOptionalWhen true, run lead enrichment after each matched author is enrolled. Defaults to false.
dryRunbooleanOptionalWhen true, validate and return the planned resources without creating anything. Defaults to false.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_conversationsGet 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).
conversationIdstringOptionalConversation ID. If provided, returns full details including lead, campaign, tags, and participants. If omitted, lists conversations with filters.
includeStatsbooleanOptionalInclude inbox statistics (total, active, closed, unread counts, counts by channel and tag). Only applies when listing conversations. Default: false.
countOnlybooleanOptionalReturn only the exact number of matching conversations. Use with inboundDateFrom and inboundDateTo to count conversations that received an inbound reply in that range.
channelstringOptionalFilter by communication channel
One of: email, linkedin, twitter, instagram, whatsapp, slack, sms
statusstringOptionalFilter by conversation status
One of: active, closed, snoozed, spam
searchstringOptionalSearch 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.
isPinnedbooleanOptionalFilter for pinned conversations only
isStarredbooleanOptionalFilter for starred conversations only
isArchivedbooleanOptionalFilter for archived conversations. Default shows non-archived.
hasUnreadbooleanOptionalFilter for conversations with unread messages
isUnassignedbooleanOptionalFilter for unassigned conversations
hasNoReplybooleanOptionalFilter for conversations where the brand has not replied
noInboundReplybooleanOptionalFilter for outbound-only conversations (no inbound messages)
hasInboundReplybooleanOptionalFilter 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.
timeFilterstringOptionalTime-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
inboundDateFromstringOptionalInclusive lower bound for actual inbound message sent time. Must be an ISO 8601 timestamp with a UTC designator or numeric offset.
inboundDateTostringOptionalExclusive upper bound for actual inbound message sent time. Must be an ISO 8601 timestamp with a UTC designator or numeric offset.
prioritystringOptionalFilter by priority level
One of: high, medium, low
tagNamestringOptionalFilter by tag name (ordinary labels)
assignedToUserIdstringOptionalFilter by assigned user ID
leadIdstringOptionalFilter by lead ID
crmStageIdsstring[]OptionalPipeline stages, OR with no stage and not in CRM
hasNoCrmStagebooleanOptionalLinked contacts without a pipeline stage
hasNoLeadbooleanOptionalConversations not linked to CRM
campaignIdstringOptionalFilter by campaign ID
pageintegerOptionalPage number for pagination (default: 1)
limitintegerOptionalItems per page (default: 50, max: 100)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_update_conversationUpdate 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.
conversationIdstringRequiredConversation ID to update
actionstringOptionalSpecial 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 | nullOptionalPipeline stage of the linked contact
expectedVersionintegerOptionalCurrent linked contact stageVersion, required for stage changes
reopenConfirmedbooleanOptionalsubjectstringOptionalUpdate the conversation subject
statusstringOptionalChange conversation status
One of: active, closed, snoozed, spam
isPinnedbooleanOptionalPin or unpin the conversation
isStarredbooleanOptionalStar or unstar the conversation
isArchivedbooleanOptionalArchive or unarchive the conversation
assignedToUserIdstringOptionalAssign the conversation to a user by their user ID
prioritystringOptionalSet the conversation priority
One of: high, medium, low
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_messagesGet 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).
conversationIdstringOptionalConversation ID to get messages for. If omitted, returns the unread message count for the current brand.
campaignIdstringOptionalRestrict messages to conversations belonging to this campaign
pageintegerOptionalPage number (default: 1). Messages are ordered oldest-first.
limitintegerOptionalMessages per page (default: 50, max: 100)
includeHtmlbooleanOptionalAlso return htmlContent, the original HTML body of each message (null for non-email channels). Default false.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_send_messageSend 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.
conversationIdstringRequiredConversation ID to send the message in
contentstringOptionalMessage content (plain text). For email, this is the text version. Required unless draftId is given or, for email, htmlContent is given.
htmlContentstringOptionalHTML content for email messages. If provided, used as the email body.
draftIdstringOptionalSend 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.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_custom_viewsManage 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).
actionstringRequiredAction to perform on custom views
One of: list, create, update, delete
viewIdstringOptionalView ID (required for "update" and "delete" actions)
namestringOptionalView name (required for "create")
descriptionstringOptionalView description
emojistringOptionalEmoji icon for the view
sortOrderintegerOptionalDisplay order among views
filtersobjectOptionalFilter configuration as JSON. Supports keys: status, channel, timeFilter, priority, hasUnread, isUnassigned, hasNoReply, isPinned, isStarred, tagName, search.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_automationsManage 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).
actionstringRequiredAction 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
ruleIdstringOptionalRule ID (required for get, update, toggle, delete; optional filter for get_logs)
typestringOptionalRule 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
namestringOptionalRule name (required for create)
crmStageIdsstring[] | nullOptionalreplyIntentMatchstring | nullOptionaltagMatchstringOptionalOnly 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[] | nullOptionalOnly fire for conversations that belong to one of these campaigns. Pass null or an empty array to match every campaign.
campaignIdstringOptionalShorthand for campaignIds with a single campaign.
maxRepliesPerConversationinteger | nullOptionalauto_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.
draftOnlybooleanOptionalauto_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.
runOnTagAddedbooleanOptionalauto_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.
createTaskbooleanOptionalauto_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 | nullOptionalauto_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 | nullOptionalauto_assign only. When the created task is due, in minutes after the assignment (1440 is one day). null means no due date.
channelMatchstringOptionalOnly fire for this channel (null = any channel)
One of: email, linkedin, twitter, instagram, whatsapp, slack, sms
isEnabledbooleanOptionalWhether the rule is active. Required for toggle.
assignToUserIdsstring[]OptionalUser IDs for round-robin assignment (auto_assign rules)
replyModestringOptionalReply mode: "template" for fixed text, "ai" for AI-generated (auto_reply rules)
One of: template, ai
templateContentstringOptionalTemplate content when replyMode is "template"
aiPromptstringOptionalAI 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.
delayMinutesintegerOptionalDelay 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.
sortOrderintegerOptionalDisplay order among rules
conversationIdstringOptionalFilter logs by conversation (get_logs only)
sincestringOptionalISO 8601 date to filter logs since (get_logs only)
limitintegerOptionalMax logs to return (get_logs only, default: 50)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_tasksManage 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).
actionstringRequiredAction 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
taskIdstringOptionalTask ID. Required for get, update, complete, reopen and delete.
viewstringOptionalList 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[]OptionalList only. Statuses to include. Defaults to open tasks (todo and in_progress), or every status when searching.
One of: todo, in_progress, done
assigneeUserIdsstring[]OptionalList only. Tasks assigned to these users. Resolve names with brandjet_get_team_members.
unassignedbooleanOptionalList only. Include tasks with no assignee.
teamIdsstring[]OptionalList only. Tasks set to these teams. Get team IDs from brandjet_manage_teams.
conversationIdstring | nullOptionalList: 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.
overduebooleanOptionalList only. Only open tasks whose due date has passed.
noDueDatebooleanOptionalList only. Only tasks without a due date.
dueAfterstringOptionalList only. Tasks due at or after this time.
dueBeforestringOptionalList only. Tasks due at or before this time.
searchstringOptionalList only. Match words in task titles.
includeSubtasksbooleanOptionalList 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.
sortstringOptionalList only. "due" (default) is soonest due first, "newest" is newest first, "updated" is most recently changed first.
One of: due, newest, updated
limitintegerOptionalList only. Max tasks to return (default 50).
offsetintegerOptionalList only. Number of tasks to skip, for paging.
titlestringOptionalTask title. Required for create.
descriptionstring | nullOptionalTask notes in plain text, or null to clear.
statusstringOptionalCreate and update. Task status.
One of: todo, in_progress, done
assigneeUserIdstring | nullOptionalWho 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 | nullOptionalTeam for the task, or null to clear. On create it defaults to the assignee's team when they are in exactly one team.
dueAtstring | nullOptionalDue 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.
dueAllDaybooleanOptionalTrue when the task is due on a day rather than at a time.
parentTaskIdstringOptionalCreate only. Make the new task a subtask of this task. Subtasks cannot have their own subtasks.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_teamsManage 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).
actionstringRequiredAction 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
teamIdstringOptionalTeam ID. Required for update and delete.
namestringOptionalTeam name, unique within the brand. Required for create.
memberUserIdsstring[]OptionalCreate: the first members. Update: replaces the whole member list. Members must belong to the brand; resolve them with brandjet_get_team_members.
addMemberUserIdsstring[]OptionalUpdate only. Add these members and keep the others.
removeMemberUserIdsstring[]OptionalUpdate only. Remove these members and keep the others.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_snippetsManage 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).
actionstringRequiredAction 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
snippetIdstringOptionalSnippet ID. Required for get, update and delete.
searchstringOptionalList only. Match snippet names.
namestringOptionalSnippet name. Required for create.
contentstringOptionalSnippet 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 | nullOptionalList: only this category. Create and update: group the snippet under this category, or null to clear it.
channelstring | nullOptionalList: snippets for this channel, including those for every channel. Create and update: limit the snippet to one channel, or null for every channel.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_send_outreach_messageSend 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.
idempotencyKeystringOptionalStable request key to reuse when retrying the same outreach request. Use a new key for a deliberate new message.
channelstringRequiredChannel 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[]RequiredLead 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.
contentstringRequiredPlain-text message body. For email this is the text version (or the body when htmlContent is not provided).
htmlContentstringOptionalOptional HTML body. Email only. When provided it is used as the email body and sanitized for tracking pixels.
subjectstringOptionalEmail subject line. Email only. If omitted, a default outreach subject is generated.
emailAccountIdstringOptionalOptional email account ID to send from. Email only. If omitted, the first connected email account for the brand is used.
integrationIdstringOptionalExact 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.
spreadSecondsintegerOptionalSeconds between each send when leadIds.length > 1. Defaults: email 60s, LinkedIn 300s, Twitter/Instagram/WhatsApp 180s. Use higher values for caution.
confirmedbooleanOptionalMust 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.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_proposalsList 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.
leadIdstringOptionalFilter proposals for one lead.
campaignIdstringOptionalFilter proposals attributed to one campaign.
statusstringOptionalFilter by proposal status.
One of: draft, sent, viewed, signed, declined, expired, voided
pageintegerOptionalPage number, default 1.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_create_proposalCreate 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.
leadIdstringRequiredThe lead the proposal is for. The lead must have an email address.
conversationIdstringOptionalOptional Unibox conversation to attribute the proposal to. Improves campaign attribution and signed-value tracking.
titlestringOptionalProposal title. Defaults to "Proposal for <lead name>".
scopeSummarystringRequiredWhat the proposal is for, in plain language (20-500 chars). Semantic purpose only — no formatting instructions.
deliverablesstring[]RequiredThe concrete deliverables, one string each (1-12).
priceAmountnumberOptionalPrice shown in the proposal, USD. Also becomes the tracked deal value unless valueAmount is set.
valueAmountnumberOptionalTracked deal value in USD when different from the price.
timelinestringOptionalOptional timeline text.
termsstringOptionalOptional terms text.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_send_proposalSend 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.
proposalIdstringRequiredThe proposal to send, from brandjet_get_proposals or brandjet_create_proposal.
subjectstringOptionalEmail subject. Placeholders like {document_title} and {client_company} are rendered at delivery. Defaults to a sensible subject.
bodyHtmlstringOptionalEmail body HTML. Placeholders like {client_first_name}, {document_url}, and {sender_name} are rendered at delivery. Defaults to a short delivery note.
confirmedbooleanOptionalMust 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.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_proposalLoad 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.
proposalIdstringRequiredThe proposal to load, from brandjet_get_proposals.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_remind_proposalSend 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.
proposalIdstringRequiredThe proposal awaiting signature to nudge.
confirmedbooleanOptionalMust be true to actually send the reminder. Without it, the proposal status and last reminder time are returned for the user to confirm.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_void_proposalWithdraw 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.
proposalIdstringRequiredThe sent proposal to withdraw.
reasonstringOptionalOptional reason shared with the lead in the withdrawal email.
confirmedbooleanOptionalMust be true to actually void. Without it, the proposal is returned for the user to confirm.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_update_proposal_outcomeRecord 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.
proposalIdstringRequiredThe proposal to update.
outcomestringRequiredBusiness outcome, independent of signing status. Signed proposals default to won and declined ones to lost.
One of: pending, won, lost, ghosted
reasonstringOptionalWhy the deal was won, lost, or went quiet.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_send_booking_linkMint 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.
conversationIdstringOptionalThe Unibox conversation to send the booking link in. Either this or leadId is required.
leadIdstringOptionalThe lead to mint the booking link for when there is no conversation. The link is returned for you to deliver.
messagestringOptionalMessage text to send with the link. Defaults to a short suggested message containing the link.
confirmedbooleanOptionalMust be true to actually send the message into the conversation. Without it, the minted link and suggested message are returned as a preview.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_meetingsList 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.
leadIdstringOptionalFilter meetings for one lead.
upcomingbooleanOptionalOnly meetings that start in the future, soonest first.
statusstringOptionalFilter by status. Omit with upcoming: true to get confirmed meetings only.
One of: confirmed, cancelled
pageintegerOptionalPage number, default 1.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_cancel_meetingCancel 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.
meetingIdstringRequiredThe meeting to cancel, from brandjet_get_meetings.
reasonstringOptionalOptional note shown to the guest in the cancellation email.
confirmedbooleanOptionalMust be true to actually cancel. Without it, the meeting details are returned for the user to confirm.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_create_meetingAdd 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.
leadIdstringOptionalLead to attribute the meeting to, when known.
guestNamestringRequiredGuest full name.
guestEmailstringRequiredGuest email address.
guestCompanystringOptionalGuest company.
titlestringOptionalMeeting title.
startsAtstringRequiredMeeting start as an ISO 8601 timestamp with timezone offset, e.g. 2026-09-15T14:00:00Z.
durationMinutesintegerOptionalLength in minutes. Defaults to the calendar default duration.
notesstringOptionalAgenda or notes for the meeting. Shared with the guest in the confirmation email and calendar invite.
sendInvitebooleanOptionalEmail the guest a confirmation with a calendar invite. Defaults to true.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_availabilityRead 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.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_lead_listsGet 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.
leadListIdstringOptionalLead list ID. If provided, returns full details for that list. If omitted, lists all lead lists for the current brand.
searchstringOptionalSearch lead lists by name
pageintegerOptionalPage number (default: 1)
limitintegerOptionalItems per page (default: 50, max: 100)
includeStagesbooleanOptionalInclude shared pipeline stage definitions for the brand (default: false)
includeStatsbooleanOptionalInclude lead management statistics — total leads, verified, unverified, lists count (default: false)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_leadsGet 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.
leadIdstringOptionalLead ID. If provided, returns full lead details including pipeline stage, list, and social profiles. Use includeNotes to also fetch notes.
leadListIdstringOptionalFilter leads within a specific lead list. Ignored when leadId is provided.
searchstringOptionalSearch leads by name or email
crmStageIdstringOptionalFilter leads by pipeline stage ID
verificationStatusstringOptionalFilter by email verification status
One of: verified, unverified
includeNotesbooleanOptionalInclude lead notes when fetching a single lead by leadId (default: false)
includeEnrichmentDatabooleanOptionalInclude enrichment data (enrichmentStatus, lastEnrichedAt, enrichmentData) when fetching a single lead by leadId (default: false)
pageintegerOptionalPage number (default: 1)
limitintegerOptionalItems per page (default: 50, max: 100)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_create_leadCreate 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.
actionstringRequiredAction 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
listNamestringOptionalName for the new lead list (required for "create_list")
leadListIdstringOptionalTarget lead list ID (required for "create_lead" and "create_leads")
namestringOptionalLead full name (required for "create_lead"). Must be the real person name, never a placeholder.
emailstringOptionalLead email address
phoneNumberstringOptionalLead phone number (E.164 format)
linkedinProfileUrlstringOptionalLinkedIn profile URL
twitterProfileUrlstringOptionalTwitter/X profile URL
instagramProfileUrlstringOptionalInstagram profile URL
customVariablesobjectOptionalCustom personalization variables as key-value pairs (e.g., {"company": "Acme", "role": "CTO"})
leadsobject[]OptionalLead 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[].namestringRequiredLead 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[].emailstringOptionalLead email address
leads[].phoneNumberstringOptionalLead phone number (E.164 format)
leads[].linkedinProfileUrlstringOptionalLinkedIn profile URL
leads[].twitterProfileUrlstringOptionalTwitter/X profile URL
leads[].instagramProfileUrlstringOptionalInstagram profile URL
leads[].customVariablesobjectOptionalCustom personalization variables as key-value pairs
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_update_leadUpdate 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.
expectedVersionintegerOptionalLast observed stage version; reject a concurrent stage change.
reopenConfirmedbooleanOptionalExplicitly confirm moving out of a Won or Lost stage.
leadIdstringRequiredLead ID to update
actionstringOptionalAction 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
namestringOptionalUpdated lead name (action: update)
emailstringOptionalUpdated email address (action: update)
phoneNumberstringOptionalUpdated phone number (action: update)
linkedinProfileUrlstringOptionalUpdated LinkedIn URL (action: update)
twitterProfileUrlstringOptionalUpdated Twitter URL (action: update)
instagramProfileUrlstringOptionalUpdated Instagram URL (action: update)
customVariablesobjectOptionalUpdated custom variables (action: update)
crmStageIdstring | nullOptionalSet the shared pipeline stage. Null clears it. Use brandjet_manage_crm_stages to list stages. (action: update)
noteContentstringOptionalNote text to add (required for action: add_note)
noteIdstringOptionalNote ID to delete (required for action: delete_note). Get note IDs from brandjet_get_leads with includeNotes.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_lead_listsManage 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.
actionstringRequiredManage 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
leadListIdstringOptionalLead list ID (required for update_list, delete_list)
namestringOptionalNew name for the lead list (action: update_list)
listIdsstring[]OptionalLead 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.
targetListIdstringOptionalExisting list that receives the leads (action: merge_lists). Usually one of listIds. Provide this or newListName.
newListNamestringOptionalCreate a new list with this name as the merge destination (action: merge_lists). Provide this or targetListId.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_lead_statsGet 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.
includeDistributionbooleanOptionalInclude verified vs unverified lead distribution (default: false)
includeStageStatsbooleanOptionalInclude lead count per shared pipeline stage (default: false)
includeListSummarybooleanOptionalInclude summary of all lead lists with counts (default: false)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_lead_collectionsManage 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.
actionstringRequiredAction 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
collectionIdstringOptionalCollection ID (required for status, pause, resume, retry, delete)
searchstringOptionalSearch collections by name (action: list)
pageintegerOptionalPage number (action: list, default: 1)
limitintegerOptionalItems per page (action: list, default: 50)
searchQuerystringOptionalPlain 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.
collectionLimitintegerOptionalMaximum number of leads to collect (required for create_linkedin and create_instagram)
collectionNamestringOptionalDisplay name for the collection (action: create_linkedin)
usernamestringOptionalInstagram username to collect followers/following from (action: create_instagram)
postLinkstringOptionalInstagram post URL to collect likes/comments from (action: create_instagram)
collectFollowersbooleanOptionalCollect followers of the username (action: create_instagram)
collectFollowingbooleanOptionalCollect following of the username (action: create_instagram)
collectLikesbooleanOptionalCollect likes on the post (action: create_instagram)
collectCommentsbooleanOptionalCollect comments on the post (action: create_instagram)
leadListIdstringOptionalTarget lead list to store collected leads in (action: create_linkedin, create_instagram)
isContinuousbooleanOptionalRun collection continuously with daily limits (action: create_linkedin, create_instagram, default: false)
autoVerifybooleanOptionalAutomatically verify collected email addresses (action: create_linkedin, create_instagram, default: false)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_crm_stagesManage 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.
outcomestringOptionalStage outcome for create or update. Won and Lost stop automatic progression.
One of: open, won, lost
replacementStageIdstring | nullOptionalRequired for delete. Reassign leads to this stage, or explicitly null for No Stage.
actionstringRequiredAction 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
stageIdstringOptionalCRM stage ID (required for update, delete)
namestringOptionalStage name (required for create, optional for update)
colorstringOptionalHex color for the stage, e.g. "#3498db" (optional for create, update)
positionintegerOptionalStage position in the pipeline (optional for create)
stageIdsstring[]OptionalOrdered array of all stage IDs to set display order (required for reorder)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_crm_leadsManage 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).
expectedVersionintegerOptionalLast observed stage version for update_stage.
reopenConfirmedbooleanOptionalExplicitly confirm moving out of a Won or Lost stage.
actionstringRequiredAction 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
leadIdstringOptionalLead ID (required for update_stage, update_assignee)
crmStageIdstring | nullOptionalCRM stage ID to move the lead to. Pass null to unset. (action: update_stage)
assignedToIdstring | nullOptionalUser ID to assign the lead to. Pass null to unassign. (action: update_assignee)
stageIdstringOptionalFilter leads by CRM stage (action: get_crm_leads)
assigneeIdstringOptionalFilter leads by assignee (action: get_crm_leads)
searchstringOptionalSearch leads by name or email (action: get_crm_leads)
pageintegerOptionalPage number (action: get_crm_leads, default: 1)
limitintegerOptionalItems per page (action: get_crm_leads, default: 50)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_advanced_filter_leadsFilter 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.
logicstringOptionalHow to combine conditions: AND (all must match) or OR (any must match). Default: AND.
One of: AND, OR
conditionsobject[]RequiredArray 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"RequiredOne 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"RequiredOne 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 | objectOptionalconditions[].value.fromstringRequiredconditions[].value.tostringRequiredsortFieldstringOptionalField to sort results by
One of: name, email, createdAt, updatedAt, source
sortOrderstringOptionalSort direction (default: DESC)
One of: ASC, DESC
pageintegerOptionalPage number (default: 1)
limitintegerOptionalItems per page (default: 25, max: 200)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_bulk_lead_operationsPerform 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.
reopenConfirmedbooleanOptionalExplicitly 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[]OptionalLead IDs for bulk operations (required for bulk_crm_stage, bulk_assignee; optional for bulk_delete)
crmStageIdstring | nullOptionalCRM stage to assign. Null = unset. (required for bulk_crm_stage)
assignedToIdstring | nullOptionalUser to assign leads to. Null = unassign. (required for bulk_assignee)
deleteAllMatchingbooleanOptionalDelete all leads matching the filters below instead of specific IDs (action: bulk_delete)
leadListIdstringOptionalFilter by lead list when using deleteAllMatching (action: bulk_delete)
verificationStatusstringOptionalFilter by verification status when using deleteAllMatching (action: bulk_delete)
filterCrmStageIdstringOptionalFilter by pipeline stage when using deleteAllMatching (action: bulk_delete)
searchstringOptionalFilter by search text when using deleteAllMatching (action: bulk_delete)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_lead_timelineGet 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).
leadIdstringRequiredLead ID to get activity timeline for
pageintegerOptionalPage number (default: 1)
limitintegerOptionalItems per page (default: 25)
typestringOptionalFilter 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
includeSummarybooleanOptionalIf true, include a summary block with current workflow step per active execution and the next scheduled action (send/open/click) for the lead.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_suppression_statusCheck 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[]RequiredEmail addresses to check (1-500). Matching is case-insensitive and does not require the address to belong to an existing lead.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_email_accountsGet 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).
accountIdstringOptionalEmail account ID. If provided, returns full details for that account. If omitted, lists all email accounts for the current brand.
providerstringOptionalFilter by email provider (google, outlook, azure, smtp)
One of: google, outlook, azure, smtp
statusstringOptionalFilter by account status (connected, disconnected, error, pending)
One of: connected, disconnected, error, pending
searchstringOptionalSearch by account name or email address
pageintegerOptionalPage number (default: 1)
limitintegerOptionalItems per page (default: 50, max: 100)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_email_accountsManage 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.
actionstringOptionalAction 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
accountIdstringOptionalEmail account ID (required for update, verify, delete)
accountIdsstring[]OptionalEmail account IDs (required for bulk_update_limits, bulk_delete)
namestringOptionalUpdated display name (action: update)
replyToAddressstringOptionalUpdated reply-to email address (action: update)
signaturestringOptionalUpdated email signature HTML (action: update)
bccToCrmstringOptionalBCC email for CRM forwarding (action: update)
dailyLimitintegerOptionalMaximum emails per day (action: update, bulk_update_limits)
hourlyLimitintegerOptionalMaximum emails per hour (action: update, bulk_update_limits)
minimumTimeGapintegerOptionalMinimum minutes between emails (action: update, bulk_update_limits)
randomAdditionalMinutesintegerOptionalRandom additional minutes between emails for human-like sending (action: update, bulk_update_limits)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_integrationsGet 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).
integrationIdstringOptionalIntegration ID. If provided, returns full details including platform-specific profile metadata. If omitted, lists all integrations for the current brand.
typestringOptionalFilter by integration type (e.g., linkedin, twitter, instagram)
One of: slack, discord, teams, webhook, twitter, instagram, reddit, youtube, linkedin, whatsapp
activeOnlybooleanOptionalIf true, only return active and enabled integrations (default: false)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_integrationsManage 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.
actionstringRequiredAction 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
integrationIdstringOptionalIntegration ID (required for update, toggle, delete)
integrationIdsstring[]OptionalIntegration IDs (required for bulk_delete)
namestringOptionalUpdated display name (action: update)
descriptionstringOptionalUpdated description (action: update)
isEnabledbooleanOptionalEnable or disable the integration (action: update)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_website_analyticsManage 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).
actionstringRequiredAction 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
domainstringOptionalWebsite domain without protocol (required for register). Example: "example.com"
namestringOptionalDisplay name for the website (optional for register, used for update)
timezonestringOptionalTimezone for analytics data (optional for register, default: UTC). Example: "America/New_York"
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_website_analyticsGet 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.
actionstringRequiredStat 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
presetstringOptionalDate 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
startDatestringOptionalStart date in ISO format (required when preset is "custom"). Example: "2026-01-01"
endDatestringOptionalEnd date in ISO format (required when preset is "custom"). Example: "2026-01-31"
granularitystringOptionalTime granularity for chart data: "hour" or "day"
One of: hour, day
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_website_analytics_breakdownGet 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).
actionstringRequiredBreakdown 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
presetstringOptionalDate 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
startDatestringOptionalStart date in ISO format (required when preset is "custom")
endDatestringOptionalEnd date in ISO format (required when preset is "custom")
granularitystringOptionalTime granularity: "hour" or "day"
One of: hour, day
referrerstringOptionalFilter by referrer source (e.g., "google.com")
campaignstringOptionalFilter by UTM campaign name
pagestringOptionalFilter by page path (e.g., "/pricing")
entryPagestringOptionalFilter by entry page path
countrystringOptionalFilter by country code (e.g., "US")
citystringOptionalFilter by city name
browserstringOptionalFilter by browser name (e.g., "Chrome")
osstringOptionalFilter by operating system (e.g., "Windows")
languagestringOptionalFilter by language code (e.g., "en")
channelstringOptionalFilter by traffic channel (e.g., "organic", "direct", "social")
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_mentionsGet 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).
mentionIdstringOptionalMention ID. If provided, returns full details for that mention including replies. If omitted, returns a paginated list of mentions with filters.
platformsstring[]OptionalFilter by platform(s). Example: ["twitter", "reddit"]
One of: twitter, reddit, youtube, news, linkedin, tiktok
sentimentTypestringOptionalFilter by sentiment type
One of: positive, negative, neutral, mixed
statusstringOptionalFilter by mention status (unread, read, archived, needs_response, responded)
One of: unread, read, archived, needs_response, responded
prioritystringOptionalFilter by mention priority (low, medium, high)
One of: low, medium, high
searchstringOptionalSearch within mention content (case-insensitive)
matchedKeywordstringOptionalFilter by the keyword that triggered this mention
minEngagementintegerOptionalMinimum engagement count filter
isCrisisAlertbooleanOptionalFilter for crisis alerts only
brandOnlybooleanOptionalWhen 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.
competitorIdstringOptionalFilter mentions for a specific competitor. Use this OR competitorIds, not both (competitorId wins if both are set).
competitorIdsstring[]OptionalFilter mentions across multiple competitors in one call. Mutually exclusive with competitorId.
startDatestringOptionalFilter mentions published after this ISO date. Example: "2026-01-01T00:00:00Z"
endDatestringOptionalFilter mentions published before this ISO date. Example: "2026-02-01T00:00:00Z"
sortBystringOptionalSort field (default: publishedAt)
One of: createdAt, publishedAt, engagementCount, sentimentScore, reachEstimate
sortOrderstringOptionalSort direction (default: DESC)
One of: ASC, DESC
pageintegerOptionalPage number (default: 1)
limitintegerOptionalItems per page (default: 20, max: 100)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_mention_statsGet 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).
actionstringRequiredStat 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
timeframestringOptionalTimeframe for live stats (only used with action "live", default: "24h")
One of: 24h, 1w, lifetime
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_mentionsManage 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).
actionstringRequiredAction 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
mentionIdstringOptionalMention ID (required for update_status)
mentionIdsstring[]OptionalArray of mention IDs (required for bulk_update_status and bulk_delete)
matchedKeywordstringOptionalMatched keyword to delete mentions for (required for delete_by_keyword)
competitorIdstringOptionalCompetitor ID when deleting mentions for a competitor keyword
statusstringOptionalNew 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
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_mention_replyReply 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.
actionstringRequiredAction 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
mentionIdstringOptionalMention ID (required for reply, generate_ai_reply, get_replies)
replyTextstringOptionalText content of the reply (required for action "reply")
socialAccountIdstringOptionalSpecific 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.
accountIdstringOptionalDeprecated alias for socialAccountId. Prefer socialAccountId in new code.
confirmedbooleanOptionalRequired 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.
replyIdstringOptionalReply ID (required for delete_reply)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_sentiment_dashboardGet 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).
actionstringRequiredDashboard 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
timeframestringOptionalAnalysis timeframe (default: "7d"). Not used for "highlights" action which analyzes across multiple timeframes automatically.
One of: 1d, 3d, 7d, 14d, 30d
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_agentsGet 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.
actionstringRequiredAction 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
agentIdstringOptionalAgent ID (required for "get" action)
pageintegerOptionalPage number (default: 1, for "list" action)
limitintegerOptionalItems per page (default: 20, for "list" action)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_agentsManage 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.
actionstringRequiredAction 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
agentIdstringOptionalAgent ID (required for update, delete, activate, deactivate, duplicate, scan)
typestringOptionalAgent type (required for "create")
One of: mention_reply, lead_collector, conversation_reply
namestringOptionalAgent name (required for "create")
descriptionstringOptionalAgent description
isActivebooleanOptionalWhether agent should be active on creation
requiresApprovalbooleanOptionalWhether agent replies need manual approval before posting
personalityobjectOptionalAgent personality configuration
personality.rolestringOptionalRole the agent embodies (e.g., "Product Expert", "Community Manager")
personality.namestringOptionalDisplay name the agent uses when replying
personality.tonestringOptionalOne of: professional, friendly, casual, formal, helpful, empathetic
personality.contextstringOptionalBackground context about the brand or product the agent should know
personality.additionalInstructionsstringOptionalExtra instructions for reply generation (e.g., "always include a CTA", "keep replies under 280 chars")
conditionsobjectOptionalConditions for when the agent should act
conditions.platformsstring[]OptionalPlatforms to monitor: twitter, reddit, linkedin, youtube
conditions.sentimentstring[]OptionalSentiment types: positive, neutral, negative
conditions.keywordsstring[]OptionalKeywords that trigger responses
conditions.excludeKeywordsstring[]OptionalKeywords that prevent responses
conditions.authorMinFollowersintegerOptionalOnly respond to authors with at least this many followers
conditions.authorMaxFollowersintegerOptionalOnly respond to authors with at most this many followers
conditions.authorVerifiedOnlybooleanOptionalOnly respond to verified or blue-check authors
sampleRepliesstring[]OptionalSample replies for tone calibration
newNamestringOptionalName for the duplicated agent (for "duplicate" action)
agentTypestringOptionalAgent type for AI generation (required for "generate_config")
One of: mention_reply, lead_collector, conversation_reply
userContextstringOptionalNatural language description of what the agent should do (required for "generate_config", max 2000 chars)
targetLeadListIdstringOptionalTarget lead list ID (for lead_collector agents)
linkedCampaignIdstringOptionalLinked campaign ID (for lead_collector agents)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_agent_accountsManage 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.
actionstringRequiredAction 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
agentIdstringRequiredAgent ID (required for all actions)
integrationIdstringOptionalIntegration account ID (required for "assign" and "remove")
assignmentIdstringOptionalAssignment ID (required for "update")
priorityintegerOptionalAssignment priority (higher = preferred). Used with "assign" and "update".
isActivebooleanOptionalWhether the assignment is active. Used with "update".
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_agent_executionsView 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.
actionstringRequiredAction 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
executionIdstringOptionalExecution ID (required for "get" and "logs")
agentIdstringOptionalAgent ID (required for "by_agent" and "stats", optional filter for "list")
mentionIdstringOptionalMention ID (required for "by_mention")
statusstringOptionalFilter by execution status (for "list" action)
One of: pending, evaluating, generating, awaiting_approval, executing, completed, failed, skipped, rate_limited
pageintegerOptionalPage number (default: 1)
limitintegerOptionalItems per page (default: 20)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_pending_repliesManage 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.
actionstringRequiredAction 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
replyIdstringOptionalPending reply ID (required for "get", "approve", "reject")
replyIdsstring[]OptionalArray of pending reply IDs (required for "bulk_approve", "bulk_reject")
agentIdstringOptionalFilter by agent ID (for "list" action)
statusstringOptionalFilter by status (for "list" action)
One of: pending, approved, rejected, expired, executed, failed
editedTextstringOptionalEdited reply text to use instead of AI-generated text (for "approve")
reasonstringOptionalRejection reason (for "reject" and "bulk_reject")
pageintegerOptionalPage number (default: 1, for "list" action)
limitintegerOptionalItems per page (default: 20, for "list" action)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_llm_monitorsManage 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).
actionstringRequiredAction 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
monitorIdstringOptionalMonitor ID (required for get_monitor, update_monitor, delete_monitor, retry_setup)
personaIdstringOptionalPersona ID (required for create_monitor)
namestringOptionalName (for create/update monitor)
descriptionstringOptionalDescription (for create/update monitor)
languagestringOptionalLanguage code, e.g. "en" (for create/update monitor)
countrystringOptionalCountry, e.g. "US" (for create/update monitor)
initialPromptstringOptionalInitial prompt instructions (for create/update monitor)
selectedModelsstring[]OptionalArray of LLM model IDs to use (for create/update monitor)
isActivebooleanOptionaltrue activates the monitor (re-driving asynchronous setup when needed: status becomes setting_up, then active), false deactivates it (for update_monitor)
runFrequencystringOptionalHow 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[]OptionalUser-reviewed queries to persist at creation; when provided, setup skips AI auto-generation (for create_monitor)
initialQueries[].queryTextstringRequiredinitialQueries[].categorystringOptionalOne of: direct_brand, competitor_comparison, industry_recommendations, problem_solving, sentiment_probing, use_case_specific, news_and_trends, technical_evaluation
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_personasManage 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).
actionstringRequiredAction 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
personaIdstringOptionalPersona ID (required for update, delete)
namestringOptionalPersona name (required for create)
descriptionstringOptionalPersona description
ageRangestringOptionalPersona age range: 18_24, 25_34, 35_44, 45_54, 55_64, 65_plus
educationLevelstringOptionalPersona education: high_school, bachelors, masters, doctorate, vocational, other
excludeNamesstring[]OptionalNames to exclude when suggesting a persona
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_available_modelsGet the list of available LLM models that can be used for AI monitoring. Returns models grouped by platform.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_llm_dashboardGet 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).
actionstringRequiredAction 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
monitorIdstringOptionalMonitor ID (required for monitor_visibility, monitor_model_stats)
daysintegerOptionalNumber of days to look back (default: 7 for visibility, 30 for stats)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_llm_queriesGet 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.
actionstringRequiredAction 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
queryIdstringOptionalQuery ID (required for "details" and "blog_strategy")
monitorIdstringOptionalFilter by monitor ID (for "list" and "responses")
personaIdstringOptionalFilter by persona ID (for "list")
daysintegerOptionalDays to look back (default: 7, valid: 7, 14, 30, 90)
categorystringOptionalFilter by query category (for "list")
searchstringOptionalSearch text in queries or responses (for "list" and "responses")
sortBystringOptionalSort field: queryText, category, mentionCount, lastExecutedAt, createdAt (for "list")
sortOrderstringOptionalSort direction (default: DESC)
One of: ASC, DESC
modestringOptionalResponse mode: "full" includes responses, "minimal" is lighter (for "list")
One of: full, minimal
pageintegerOptionalPage number (default: 1)
limitintegerOptionalItems per page (default: 20)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_llm_queriesManage 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.
actionstringRequiredAction 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[]OptionalArray of query IDs (required for bulk_activate, bulk_deactivate, bulk_delete)
monitorIdstringOptionalMonitor ID (required for "create_custom")
queryTextstringOptionalQuery text (required for "create_custom")
categorystringOptionalQuery 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
priorityintegerOptionalPriority 1-4: low, medium, high, critical (for "create_custom")
queryLanguagestringOptionalLanguage code for the query, e.g. "en-US" (for "create_custom")
notesstringOptionalNotes about the query (for "create_custom")
executeImmediatelybooleanOptionalExecute query immediately after creation (default: true, for "create_custom")
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_competitorsGet 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.
actionstringRequiredAction 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
competitorIdstringOptionalCompetitor ID (required for "get" and "enhancement_status")
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_competitorsManage 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
competitorIdstringOptionalCompetitor ID (required for update, delete, toggle_active, update_platforms)
namestringOptionalCompetitor name (required for "create", optional for "update")
websitestringOptionalCompetitor website URL
logostringOptionalCompetitor logo URL. Ignored unless it is an http(s) URL that fits the 255 character storage limit; an unusable value never blocks the competitor.
platformsobjectOptionalPlatform monitoring toggles. Each platform: true (monitor) or false (ignore).
platforms.twitterbooleanOptionalplatforms.redditbooleanOptionalplatforms.newsbooleanOptionalplatforms.youtubebooleanOptionalplatforms.linkedinbooleanOptionalplatforms.tiktokbooleanOptionalkeywordsobject[]OptionalKeywords to monitor (only for "update"). Replaces all existing keywords.
keywords[].valuestringRequiredKeyword to monitor
keywords[].tagstringOptionalTag for categorization
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_competitor_actionTrigger 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
competitorIdstringRequiredCompetitor ID
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_support_ticketsGet 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.
ticketIdstringOptionalTicket ID. If provided, returns full ticket details including comments and attachments. If omitted, returns a paginated list of the user's tickets.
statusstringOptionalFilter by ticket status
One of: open, in_progress, awaiting_response, resolved, closed
categorystringOptionalFilter by ticket category
One of: bug_report, feature_request, general_support
pageintegerOptionalPage number (default: 1)
limitintegerOptionalItems per page (default: 10, max: 100)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_create_support_ticketCreate a new support ticket for the current user. Requires a subject, description, and category. Priority defaults to "medium" if not specified.
subjectstringRequiredTicket subject/title (max 255 characters)
descriptionstringRequiredDetailed description of the issue or request
categorystringRequiredTicket 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
prioritystringOptionalTicket priority (default: "medium"). Use "urgent" only for critical production issues.
One of: low, medium, high, urgent
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_support_ticketsAdd 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).
actionstringRequiredAction to perform. "add_comment" adds a comment to an existing ticket.
One of: add_comment
ticketIdstringRequiredTicket ID (required for all actions)
contentstringOptionalComment text content (required for add_comment)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_list_all_toolsList 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.
categorystringOptionalFilter 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.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_user_settingsGet 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.
typestringRequiredType 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
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_user_settingsUpdate 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).
actionstringRequiredAction to perform. "update_profile" updates profile fields. "update_notifications" updates notification preferences.
One of: update_profile, update_notifications
firstNamestringOptionalFirst name (action: update_profile)
lastNamestringOptionalLast name (action: update_profile)
phonestringOptionalPhone number (action: update_profile)
companystringOptionalCompany name (action: update_profile)
positionstringOptionalJob title/position (action: update_profile)
biostringOptionalShort bio, max 500 chars (action: update_profile)
websitestringOptionalPersonal/company website URL (action: update_profile)
countrystringOptionalCountry of residence (action: update_profile)
emailNotificationsbooleanOptionalMaster email toggle (action: update_notifications)
mentionAlertsbooleanOptionalAlert on new mentions (action: update_notifications)
sentimentAlertsbooleanOptionalAlert on sentiment changes (action: update_notifications)
dailyReportsbooleanOptionalDaily report emails (action: update_notifications)
weeklyDigestbooleanOptionalWeekly digest emails (action: update_notifications)
securityAlertsbooleanOptionalSecurity-related alerts (action: update_notifications)
marketingEmailsbooleanOptionalMarketing/promotional content (action: update_notifications)
interestedReplyAlertsbooleanOptionalAlerts when interested leads reply (action: update_notifications)
productUpdatesbooleanOptionalProduct update notifications (action: update_notifications)
crisisAlertsbooleanOptionalCrisis/emergency alerts (action: update_notifications)
campaignNotificationsbooleanOptionalCampaign notification emails -- daily summary, errors, completions (action: update_notifications)
signalNotificationsbooleanOptionalSignal engine notification emails -- source completed, messages ready to review, campaign launched (action: update_notifications)
emailFrequencystringOptionalEmail delivery frequency (action: update_notifications)
One of: hourly, daily, weekly
sentimentThresholdstringOptionalSentiment filtering level (action: update_notifications)
One of: all, negative, critical
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_brand_settingsGet 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).
typestringRequiredType 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
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_brand_settingsUpdate 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.
actionstringRequiredAction 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
namestringOptionalBrand name (action: update_info)
descriptionstringOptionalBrand description (action: update_info)
websitestringOptionalBrand website URL (action: update_info)
industrystringOptionalIndustry category (action: update_info)
businessTypestringOptionalBusiness type, e.g. SaaS (action: update_info)
targetAudiencestring[]OptionalArray of audience segments (action: update_info)
twitterbooleanOptionalToggle Twitter/X monitoring (action: update_platforms)
redditbooleanOptionalToggle Reddit monitoring (action: update_platforms)
newsbooleanOptionalToggle News monitoring (action: update_platforms)
youtubebooleanOptionalToggle YouTube monitoring (action: update_platforms)
linkedinbooleanOptionalToggle LinkedIn monitoring (action: update_platforms)
tiktokbooleanOptionalToggle TikTok monitoring (action: update_platforms)
llmbooleanOptionalToggle LLM/AI model monitoring (action: update_platforms)
sentimentThresholdValuenumberOptionalSentiment threshold from -1.0 to 1.0 (action: update_alerts)
volumeThresholdnumberOptionalVolume threshold - mentions per hour (action: update_alerts)
crisisKeywordsstring[]OptionalKeywords that trigger crisis alerts (action: update_alerts)
emailAlertsbooleanOptionalEnable email alerts (action: update_alerts)
slackAlertsbooleanOptionalEnable Slack alerts (action: update_alerts)
webhookUrlstringOptionalWebhook URL for custom notifications (action: update_alerts)
socialTwitterstringOptionalTwitter handle without @ (action: update_social_accounts)
socialLinkedinstringOptionalLinkedIn company URL (action: update_social_accounts)
socialFacebookstringOptionalFacebook page URL (action: update_social_accounts)
socialInstagramstringOptionalInstagram handle without @ (action: update_social_accounts)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_brand_membersManage 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.
actionstringRequiredAction 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
emailstringOptionalEmail of the person to invite (action: invite)
rolestringOptionalRole to assign: "admin" or "viewer" (action: invite, change_role)
One of: admin, viewer
memberIdstringOptionalMember ID (action: change_role, remove)
invitationIdstringOptionalInvitation ID (action: cancel_invitation)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_team_membersList 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.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_email_warmupManage 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).
actionstringRequiredAction 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
accountIdstringOptionalEmail account ID (required for enable, disable)
accountIdsstring[]OptionalEmail account IDs (required for bulk_enable, bulk_disable)
maxDailyCountintegerOptionalMaximum warmup emails per day (default: 40). Used with enable/bulk_enable.
dailyIncrementintegerOptionalNumber of additional warmup emails added per day during ramp-up (default: 2). Used with enable/bulk_enable.
startCountintegerOptionalNumber of warmup emails on day 1 (default: 5). Used with enable/bulk_enable.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_search_lead_databaseSearch 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[]OptionalCurrent job title or titles, matched as contains (e.g. ["CTO", "Chief Technology Officer"]). Combined with filters.jobTitles.
companystring[]OptionalCurrent company name or names. Combined with filters.companyNames.
industrystring[]OptionalLinkedIn industry name or names (e.g. "Software Development"). Combined with filters.industries.
countrystring[]OptionalCountry or countries where the person is based (e.g. "United States"). Combined with filters.personLocations.
filtersobjectOptionalLead 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[]OptionalCurrent job title or titles, matched as contains (e.g. ["CTO", "Chief Technology Officer"]). Combined with filters.jobTitles.
filters.excludeJobTitlesstring[]Optionalfilters.senioritiesstring[]Optionalfilters.departmentsstring[]Optionalfilters.personLocationsstring[]OptionalCountry or countries where the person is based (e.g. "United States"). Combined with filters.personLocations.
filters.excludePersonLocationsstring[]Optionalfilters.yearsOfExperienceMinintegerOptionalfilters.yearsOfExperienceMaxintegerOptionalfilters.personNamesstring[]Optionalfilters.verifiedEmailOnlybooleanOptionalfilters.verifiedMobileOnlybooleanOptionalfilters.companyNamesstring[]OptionalCurrent company name or names. Combined with filters.companyNames.
filters.excludeCompanyNamesstring[]Optionalfilters.companyDomainsstring[]Optionalfilters.excludeCompanyDomainsstring[]Optionalfilters.industriesstring[]OptionalLinkedIn industry name or names (e.g. "Software Development"). Combined with filters.industries.
filters.excludeIndustriesstring[]Optionalfilters.employeeCountMinintegerOptionalfilters.employeeCountMaxintegerOptionalfilters.revenueMinstringOptionalOne of: <100K, 100K, 500K, 1M, 5M, 10M, 25M, 50M, 100M, 250M, 500M, 1B, 5B, 10B+
filters.revenueMaxstringOptionalOne of: <100K, 100K, 500K, 1M, 5M, 10M, 25M, 50M, 100M, 250M, 500M, 1B, 5B, 10B+
filters.fundingStagesstring[]Optionalfilters.technologiesstring[]Optionalfilters.excludeTechnologiesstring[]Optionalfilters.companyLocationsstring[]Optionalfilters.excludeCompanyLocationsstring[]Optionalfilters.foundedMinintegerOptionalfilters.foundedMaxintegerOptionalfilters.companyKeywordsstring[]Optionalfilters.naicsCodesinteger[]Optionalfilters.sicCodesinteger[]OptionalpageintegerOptionalPage number (default: 1). Each page has 25 results. Pages 1 to 3 are free; later pages cost 1 credit per result returned.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_find_contact_infoFind 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).
actionstringRequiredAction 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
firstNamestringOptionalPerson's first name (required for find_email)
lastNamestringOptionalPerson's last name (required for find_email)
domainstringOptionalCompany domain, e.g. "acme.com" (required for find_email)
linkedinProfilestringOptionalLinkedIn profile URL (required for linkedin_to_email, optional for find_phone)
emailstringOptionalEmail address (optional for find_phone)
personobjectOptionalOne 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.idstringRequiredThe "id" of the brandjet_search_lead_database result
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_enrich_leadsEnrich 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).
actionstringRequiredAction 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
leadIdstringOptionalLead ID to enrich (required for enrich_lead)
leadListIdstringOptionalLead list ID to enrich all leads in (required for enrich_list)
leadIdsstring[]OptionalArray 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.
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_search_resultsImport, 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.
actionstringRequiredAction 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[]OptionalThe 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[].idstringRequiredThe "id" of the brandjet_search_lead_database result
peopleobject[]OptionalResult 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[].idstringRequiredThe "id" of the brandjet_search_lead_database result
fieldsstring[]OptionalFields to reveal for people. Use ["email"], ["phone"], or both.
One of: email, phone
listIdstringOptionalExisting lead list ID to import/export into
newListNamestringOptionalName for a new lead list to create for import/export
scopestringOptionalExport 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
filtersobjectOptionalSearch 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[]Optionalfilters.excludeJobTitlesstring[]Optionalfilters.senioritiesstring[]Optionalfilters.departmentsstring[]Optionalfilters.personLocationsstring[]Optionalfilters.excludePersonLocationsstring[]Optionalfilters.yearsOfExperienceMinintegerOptionalfilters.yearsOfExperienceMaxintegerOptionalfilters.personNamesstring[]Optionalfilters.verifiedEmailOnlybooleanOptionalfilters.verifiedMobileOnlybooleanOptionalfilters.companyNamesstring[]Optionalfilters.excludeCompanyNamesstring[]Optionalfilters.companyDomainsstring[]Optionalfilters.excludeCompanyDomainsstring[]Optionalfilters.industriesstring[]Optionalfilters.excludeIndustriesstring[]Optionalfilters.employeeCountMinintegerOptionalfilters.employeeCountMaxintegerOptionalfilters.revenueMinstringOptionalOne of: <100K, 100K, 500K, 1M, 5M, 10M, 25M, 50M, 100M, 250M, 500M, 1B, 5B, 10B+
filters.revenueMaxstringOptionalOne of: <100K, 100K, 500K, 1M, 5M, 10M, 25M, 50M, 100M, 250M, 500M, 1B, 5B, 10B+
filters.fundingStagesstring[]Optionalfilters.technologiesstring[]Optionalfilters.excludeTechnologiesstring[]Optionalfilters.companyLocationsstring[]Optionalfilters.excludeCompanyLocationsstring[]Optionalfilters.foundedMinintegerOptionalfilters.foundedMaxintegerOptionalfilters.companyKeywordsstring[]Optionalfilters.naicsCodesinteger[]Optionalfilters.sicCodesinteger[]OptionalmaxRowsintegerOptionalMaximum 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.
includeEmailsbooleanOptionalAdd email addresses to exported leads (+2 credits/lead)
includePhonesbooleanOptionalAdd phone numbers to exported leads (+50 credits/lead)
destinationstringOptionalExport destination (required for export)
One of: csv, list, campaign
campaignIdstringOptionalExisting campaign ID when destination is "campaign"
newCampaignNamestringOptionalName for a new campaign when destination is "campaign"
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_search_filtersReturn 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.
groupIdstringOptionalOptional group id to return only filters in that group ("person", "location", "company", "industry", "technology", "funding").
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_enrichment_creditsCheck 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.
actionstringRequiredAction 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
pageintegerOptionalPage number for history (default: 1)
limitintegerOptionalItems per page for history (default: 25)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_enrichment_jobsView 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.
actionstringRequiredAction 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
jobIdstringOptionalEnrichment job ID (required for get)
leadIdstringOptionalLead ID to get enrichment history for (required for lead_history)
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_manage_saved_searchesManage 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.
actionstringRequiredAction 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
savedSearchIdstringOptionalSaved search ID (required for update, delete)
namestringOptionalName for the saved search (required for create, optional for update)
filtersobjectOptionalSearch 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[]Optionalfilters.excludeJobTitlesstring[]Optionalfilters.senioritiesstring[]Optionalfilters.departmentsstring[]Optionalfilters.personLocationsstring[]Optionalfilters.excludePersonLocationsstring[]Optionalfilters.yearsOfExperienceMinintegerOptionalfilters.yearsOfExperienceMaxintegerOptionalfilters.personNamesstring[]Optionalfilters.verifiedEmailOnlybooleanOptionalfilters.verifiedMobileOnlybooleanOptionalfilters.companyNamesstring[]Optionalfilters.excludeCompanyNamesstring[]Optionalfilters.companyDomainsstring[]Optionalfilters.excludeCompanyDomainsstring[]Optionalfilters.industriesstring[]Optionalfilters.excludeIndustriesstring[]Optionalfilters.employeeCountMinintegerOptionalfilters.employeeCountMaxintegerOptionalfilters.revenueMinstringOptionalOne of: <100K, 100K, 500K, 1M, 5M, 10M, 25M, 50M, 100M, 250M, 500M, 1B, 5B, 10B+
filters.revenueMaxstringOptionalOne of: <100K, 100K, 500K, 1M, 5M, 10M, 25M, 50M, 100M, 250M, 500M, 1B, 5B, 10B+
filters.fundingStagesstring[]Optionalfilters.technologiesstring[]Optionalfilters.excludeTechnologiesstring[]Optionalfilters.companyLocationsstring[]Optionalfilters.excludeCompanyLocationsstring[]Optionalfilters.foundedMinintegerOptionalfilters.foundedMaxintegerOptionalfilters.companyKeywordsstring[]Optionalfilters.naicsCodesinteger[]Optionalfilters.sicCodesinteger[]OptionalbrandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_find_ui_elementFind 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.
querystringRequiredNatural language query describing the UI element the user is looking for, e.g. "create campaign button", "inbox", "settings page"
availableElementsobject[]RequiredList of UI elements currently visible on the page
availableElements[].idstringRequiredThe data-artemis-id of the element
availableElements[].labelstringRequiredHuman-readable label of the element
availableElements[].descriptionstringOptionalOptional description of the element
brandIdstringOptionalBrand id for this call only (see brandjet_list_brands). Defaults to the session brand.
brandjet_get_tool_runCollect 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.
runIdstringRequiredThe runId from a call that answered with status "running".
brandIdstringOptionalThe brandId you passed on that call, if you passed one. Leave it out otherwise.