# BrandJet AI > BrandJet AI is a multi-channel outreach platform. It finds leads, runs outreach campaigns across email, LinkedIn, X (Twitter), WhatsApp and Instagram, watches social platforms for mentions of a brand, and keeps every reply in one inbox. Developers reach it through a REST API and a hosted MCP server. REST API: - Base URL: `https://api.brandjet.ai/api/v1`. - Authentication: send an API key in the `x-api-key` header. Keys start with `bj_live_`, belong to one brand, and carry scopes such as `campaigns:read` or `leads:write`. Create them in BrandJet under Settings, API Keys. - Responses wrap their payload in an envelope with `data` and `request_id`. Create and update requests accept an `Idempotency-Key` header holding a UUID. Rate limits depend on the plan and are reported in `X-RateLimit-*` response headers. MCP server: - URL: `https://mcp.brandjet.ai/mcp`, over the Streamable HTTP transport. - Authentication: OAuth 2.1 with PKCE, signed in through the browser. Clients register through Dynamic Client Registration or a client ID metadata document, and discover the server through `/.well-known/oauth-protected-resource` and `/.well-known/oauth-authorization-server` on the MCP host. An API key created with MCP access also works, sent as `Authorization: Bearer bj_live_...`, and is limited to its brand. - A login with several brands lists them with `brandjet_list_brands`, then selects one with `brandjet_switch_brand` or passes `brandId` on each call. ## Docs - [API reference](https://www.brandjet.ai/api-reference): every REST endpoint with its parameters and responses. - [OpenAPI document](https://www.brandjet.ai/api-reference/openapi-spec): the REST API as OpenAPI JSON. - [MCP tool reference](https://www.brandjet.ai/api-reference/mcp): every MCP tool with its parameters and annotations, read from the server's own tool list. - [MCP tool list](https://www.brandjet.ai/api-reference/mcp/tools): the same tools as JSON, in the shape `tools/list` returns. - [Connect an MCP client](https://www.brandjet.ai/mcp): setup steps for Claude, ChatGPT, Cursor, VS Code and other MCP clients. ## Optional - [Full reference](https://www.brandjet.ai/llms-full.txt): every REST endpoint and every MCP tool in one plain text file. ## REST endpoints Paths are relative to `https://api.brandjet.ai`. ### GET /api/v1/me Validate API key Validates the API key and returns key metadata. Use this to verify a key is active and inspect its scopes. ### GET /api/v1/me/account Get account info Returns the user account associated with this API key, including profile information. ### GET /api/v1/me/brand Get brand Returns the brand this API key is bound to. ### GET /api/v1/leads/lists List lead lists Retrieve all lead lists for the current brand. Parameters: - `page (query)` (number, optional): Page number (1-based) - `limit (query)` (number, optional): Number of items per page - `search (query)` (string, optional): Search query to filter results by name or email ### POST /api/v1/leads/lists Create a lead list Create a new empty lead list. Leads can then be added via the create lead endpoint. JSON body: - `name` (string, required): Name for the lead list - `description` (string, optional): Optional description for the lead list ### GET /api/v1/leads/lists/{listId} Get a lead list Retrieve details of a specific lead list. Parameters: - `listId (path)` (string, required): Lead list ID. ### GET /api/v1/leads/lists/{listId}/leads List leads in a list Retrieve all leads belonging to a specific lead list. Parameters: - `listId (path)` (string, required): Lead list ID. - `page (query)` (number, optional): Page number (1-based) - `limit (query)` (number, optional): Number of items per page - `search (query)` (string, optional): Search query to filter results by name or email ### POST /api/v1/leads/lists/{listId}/leads Create a lead Add a new lead to a list. At minimum, a name is required. Parameters: - `listId (path)` (string, required): Lead list ID. JSON body: - `name` (string, required): Full name of the lead - `email` (string, optional): Email address - `phoneNumber` (string, optional): Phone number in E.164 format - `linkedinProfileUrl` (string, optional): LinkedIn profile URL - `twitterProfileUrl` (string, optional): X/Twitter profile URL - `instagramProfileUrl` (string, optional): Instagram profile URL - `telegramUsername` (string, optional): Telegram username (without @) - `customVariables` (object, optional): Custom variables for personalization in campaigns ### POST /api/v1/leads/lists/import Bulk import leads into a new list Upload a CSV file to create a new lead list and import leads. The import runs asynchronously — poll the import status endpoint to track progress. ### POST /api/v1/leads/lists/{listId}/import Bulk import leads into an existing list Upload a CSV file to import leads into an existing lead list. The import runs asynchronously — poll the import status endpoint to track progress. Parameters: - `listId (path)` (string, required): Lead list ID to import into. ### GET /api/v1/leads/imports List active and recent imports Returns currently processing imports and imports completed within the last 5 minutes for the brand. ### GET /api/v1/leads/lists/{listId}/import/status Get import status Poll the progress of a bulk import for a specific lead list. Returns the current status, progress percentage (0-100), and error information if applicable. Parameters: - `listId (path)` (string, required): Lead list ID. ### GET /api/v1/leads/lists/{listId}/import/result Get import result Retrieve the detailed result of a completed bulk import, including counts for successful imports, failures, and duplicates. Parameters: - `listId (path)` (string, required): Lead list ID. ### POST /api/v1/leads/lists/{listId}/import/cancel Cancel an import Cancel a bulk import that is currently in processing state. Leads already imported before cancellation will be retained. Parameters: - `listId (path)` (string, required): Lead list ID. ### POST /api/v1/leads/suppression-check Check email suppression Check up to 500 email addresses against the brand suppression list, platform-wide address and domain suppression, and the brand domain blocklist. Read-only. Works by address, so it also covers deleted or archived leads. Campaign-only blocked domains and blocklist matches on a lead company domain are not included. Platform-wide matches return reason global and no date. Each unique address counts toward the brand's daily limit (the plan's daily API request figure, shared with the MCP tool), which resets at midnight UTC. Plans without a daily API request limit have no address limit. JSON body: - `emails` (string[], required): Email addresses to check (1-500). Matching is case-insensitive and does not require the address to belong to an existing lead. ### POST /api/v1/leads/find-email Find an email Find a person's email from their first name, last name and company domain. Costs 2 credits from the brand's credit balance when an email is found. A lookup that finds nothing, or that fails, is refunded. The API key needs leads:write and credits:spend. credits:spend is never part of * or credits:*: turn on credit spending when you create the key in Settings > API Keys. Parameters: - `idempotency-key (header)` (string, required) JSON body: - `first_name` (string, required): The person's first name. - `last_name` (string, required): The person's last name. - `domain` (string, required): The company's bare domain, such as example.com. A URL or an email address is refused. A Unicode domain is looked up in its punycode form, which the response returns. ### GET /api/v1/leads/{leadId} Get a lead Retrieve full details for a single lead including contact information and CRM stage. Parameters: - `leadId (path)` (string, required): Lead ID. ### PATCH /api/v1/leads/{leadId} Update a lead Update one or more fields on an existing lead. Only provided fields will be changed. Parameters: - `leadId (path)` (string, required): Lead ID. JSON body: - `name` (string, optional): Full name of the lead - `email` (string, optional): Email address - `phoneNumber` (string, optional): Phone number in E.164 format - `linkedinProfileUrl` (string, optional): LinkedIn profile URL - `twitterProfileUrl` (string, optional): X/Twitter profile URL - `instagramProfileUrl` (string, optional): Instagram profile URL - `telegramUsername` (string, optional): Telegram username (without @) - `customVariables` (object, optional): Custom variables for personalization in campaigns - `crmStageId` (object, optional): Shared pipeline stage ID. Null clears the stage. - `expectedVersion` (number, optional): Last observed pipeline version, used to reject concurrent changes - `reopenConfirmed` (boolean, optional): Confirm moving a lead out of a closed stage ### GET /api/v1/campaigns List campaigns List campaigns for the current brand. Parameters: - `page (query)` (number, optional): Page number (1-based) - `limit (query)` (number, optional): Number of items per page - `search (query)` (string, optional): Search query to filter results by name or email - `status (query)` (string, optional, one of: draft, active, paused, completed, archived, deleting): Filter by campaign status ### POST /api/v1/campaigns Create campaign Create a new campaign in DRAFT status. Use the API to configure settings, set the sequence with PATCH, add leads, link sending accounts, and launch, pause or resume the campaign. JSON body: - `name` (string, required): Campaign name - `type` (string, required, one of: email_sequence, outreach, nurture, sales): Campaign type - `description` (string, optional): Campaign description - `priority` (string, optional, one of: low, medium, high, urgent): Campaign priority - `target_audience` (string, optional): Target audience description - `scheduled_start_at` (string, optional): Scheduled start date (ISO 8601) - `scheduled_end_at` (string, optional): Scheduled end date (ISO 8601) - `timezone` (string, optional): Timezone (IANA) - `sending_days` (string[], optional): Days of week to send - `sending_time_start` (string, optional): Daily sending window start (HH:MM) - `sending_time_end` (string, optional): Daily sending window end (HH:MM) - `max_new_leads_per_day` (number, optional): Max new leads per day (null = no limit) - `prioritize_new_leads` (boolean, optional): Prioritize new leads over follow-ups - `respect_timezone` (boolean, optional): Respect recipient timezone - `track_opens` (boolean, optional): Track email opens (adds tracking pixel) - `track_clicks` (boolean, optional): Track link clicks (rewrites links) - `track_unsubscribes` (boolean, optional): Track unsubscribes - `include_unsubscribe_link` (boolean, optional): Include unsubscribe link in emails - `enable_utm_tracking` (boolean, optional): Enable UTM tracking on links - `utm_source` (string, optional): UTM source - `utm_medium` (string, optional): UTM medium - `utm_campaign` (string, optional): UTM campaign - `gdpr_compliant` (boolean, optional): GDPR compliant - `can_spam_compliant` (boolean, optional): CAN-SPAM compliant - `stop_sending_trigger` (string, optional, one of: reply, click, open, bounce): Stop sending trigger - `send_email_as_html_only` (boolean, optional): Send email as HTML only (disables tracking) - `enable_provider_matching` (boolean, optional): Enable provider matching (e.g. Outlook-to-Outlook) - `cc_emails` (string, optional): CC recipients (comma-separated emails) - `bcc_emails` (string, optional): BCC recipients (comma-separated emails) ### GET /api/v1/campaigns/{campaignId} Get campaign Get details of a single campaign by ID, including the active workflow definition. Parameters: - `campaignId (path)` (string, required): Campaign ID. ### PATCH /api/v1/campaigns/{campaignId} Update campaign Update campaign settings. Only provided fields are updated. Send workflow to replace the campaign's sequence. It is checked by the same rules as the MCP campaign tools, and the API key owner needs an admin role on the brand. Parameters: - `campaignId (path)` (string, required): Campaign ID. JSON body: - `name` (string, optional): Campaign name - `type` (string, optional, one of: email_sequence, outreach, nurture, sales): Campaign type - `description` (string, optional): Campaign description - `priority` (string, optional, one of: low, medium, high, urgent): Campaign priority - `target_audience` (string, optional): Target audience description - `scheduled_start_at` (string, optional): Scheduled start date (ISO 8601) - `scheduled_end_at` (string, optional): Scheduled end date (ISO 8601) - `timezone` (string, optional): Timezone (IANA) - `sending_days` (string[], optional): Days of week to send - `sending_time_start` (string, optional): Daily sending window start (HH:MM) - `sending_time_end` (string, optional): Daily sending window end (HH:MM) - `max_new_leads_per_day` (number, optional): Max new leads per day - `prioritize_new_leads` (boolean, optional): Prioritize new leads over follow-ups - `respect_timezone` (boolean, optional): Respect recipient timezone - `track_opens` (boolean, optional): Track email opens - `track_clicks` (boolean, optional): Track link clicks - `track_unsubscribes` (boolean, optional): Track unsubscribes - `include_unsubscribe_link` (boolean, optional): Include unsubscribe link - `enable_utm_tracking` (boolean, optional): Enable UTM tracking - `utm_source` (string, optional): UTM source - `utm_medium` (string, optional): UTM medium - `utm_campaign` (string, optional): UTM campaign - `gdpr_compliant` (boolean, optional): GDPR compliant - `can_spam_compliant` (boolean, optional): CAN-SPAM compliant - `stop_sending_trigger` (string, optional, one of: reply, click, open, bounce): Stop sending trigger - `send_email_as_html_only` (boolean, optional): Send email as HTML only - `enable_provider_matching` (boolean, optional): Enable provider matching - `cc_emails` (string, optional): CC recipients (comma-separated emails) - `bcc_emails` (string, optional): BCC recipients (comma-separated emails) - `workflow` (any, optional): Replace the campaign's sequence. The fields match the workflow that GET /v1/campaigns/{campaignId} returns, so a workflow read there can be edited and sent back. The whole sequence is replaced: send every node and edge, and a node sent without variants has no A/B variants afterwards. Variants are re-created as active, so a declared winner or a paused variant starts over. ### GET /api/v1/campaigns/{campaignId}/leads Get campaign leads List leads enrolled in a campaign, including their execution status. Parameters: - `campaignId (path)` (string, required): Campaign ID. - `page (query)` (number, optional): Page number (1-based) - `limit (query)` (number, optional): Number of items per page - `search (query)` (string, optional): Search query to filter results by name or email ### POST /api/v1/campaigns/{campaignId}/leads Add leads to campaign Add leads to a campaign from existing lead lists and/or by individual lead IDs. At least one of lead_list_ids or lead_ids must be provided. Parameters: - `campaignId (path)` (string, required): Campaign ID. JSON body: - `lead_list_ids` (string[], optional): Lead list IDs to add leads from - `lead_ids` (string[], optional): Individual lead IDs to add ### DELETE /api/v1/campaigns/{campaignId}/leads Remove leads from campaign Remove specific leads from a campaign by their IDs. Any sequence steps still pending for those leads are cancelled, so they receive no further follow-ups from this campaign. Parameters: - `campaignId (path)` (string, required): Campaign ID. JSON body: - `lead_ids` (string[], required): Lead IDs to remove ### PATCH /api/v1/campaigns/{campaignId}/accounts Link sending accounts Link sending accounts (email, social) to a campaign. You can provide specific account IDs, group IDs, or use select_all with filters. The response lists the requested accounts that were not linked, and the linked accounts that cannot send right now with the reason. Parameters: - `campaignId (path)` (string, required): Campaign ID. JSON body: - `account_ids` (string[], optional): Specific account IDs to link - `group_ids` (string[], optional): Account group IDs to link (snapshots current members) - `replace` (boolean, optional): Replace existing accounts (true) or merge (false) - `select_all` (boolean, optional): Link all brand accounts matching filters - `type` (string, optional, one of: email, social, mailbox): Account type filter (used with select_all) - `provider` (string, optional, one of: google, outlook, smtp, twitter, linkedin, instagram, whatsapp, slack, discord, teams, webhook, reddit, youtube, telegram): Provider filter (used with select_all) - `group_id` (string, optional): Account group filter (used with select_all) ### POST /api/v1/campaigns/{campaignId}/launch-preview Preview campaign launch Check whether the campaign can launch, without launching it or changing anything. Takes the same lead_ids and select_all as the launch and returns what blocks it, warnings, how many leads fit today, and the warmup risk that a launch would need acknowledge_warmup_risk for. These are the same checks the MCP launch preview runs, and the API key owner needs an admin role on the brand. Parameters: - `campaignId (path)` (string, required): Campaign ID. JSON body: - `lead_ids` (string[], optional): Launch only these campaign leads, up to 10,000. Every one must already be a lead of the campaign. Ignored when select_all is true. Leave both out, or send select_all, to launch every lead in the campaign. - `select_all` (boolean, optional): Launch for every lead in the campaign. ### POST /api/v1/campaigns/{campaignId}/launch Launch campaign Start sending the campaign to every lead in it, or only to the leads in lead_ids. The campaign needs an active workflow, leads and linked sending accounts, and the API key owner needs an admin role on the brand. When a sending mailbox is not warmed up yet, the launch is refused with a 409 whose message starts with LAUNCH_WARMUP_CONSENT_REQUIRED. Send acknowledge_warmup_risk: true only after a person has accepted that risk. Parameters: - `campaignId (path)` (string, required): Campaign ID. JSON body: - `lead_ids` (string[], optional): Launch only these campaign leads, up to 10,000. Every one must already be a lead of the campaign. Ignored when select_all is true. Leave both out, or send select_all, to launch every lead in the campaign. - `select_all` (boolean, optional): Launch for every lead in the campaign. - `scheduled_start_at` (string, optional): When to start sending (ISO 8601). Leave it out to start immediately. - `sending_window_start` (string, optional): Daily sending window start, HH:MM. - `sending_window_end` (string, optional): Daily sending window end, HH:MM. - `sending_days` (string[], optional, one of: monday, tuesday, wednesday, thursday, friday, saturday, sunday): Days of the week the campaign may send on. - `timezone` (string, optional): IANA timezone for the schedule. - `batch_size` (number, optional): Leads processed per batch. - `acknowledge_warmup_risk` (boolean, optional): Launch even though a sending mailbox is not warmed up yet. Without it, that launch is refused with a 409 whose message starts with LAUNCH_WARMUP_CONSENT_REQUIRED. Set it only after a person has accepted the deliverability risk. ### POST /api/v1/campaigns/{campaignId}/pause Pause campaign Stop sending. Queued steps are removed and each lead stays where it is in the sequence until the campaign is resumed. The API key owner needs an admin role on the brand. Parameters: - `campaignId (path)` (string, required): Campaign ID. ### POST /api/v1/campaigns/{campaignId}/resume Resume campaign Continue a paused campaign from where each lead stopped. The API key owner needs an admin role on the brand. A campaign that was paused automatically for a high bounce or complaint rate is refused with a 409 whose message starts with RESUME_CONSENT_REQUIRED. Send acknowledge_deliverability_risk: true only after a person has accepted that risk. Parameters: - `campaignId (path)` (string, required): Campaign ID. JSON body: - `acknowledge_deliverability_risk` (boolean, optional): Resume a campaign that was paused automatically for a high bounce or complaint rate. Without it, that resume is refused with a 409 whose message starts with RESUME_CONSENT_REQUIRED. Set it only after a person has accepted the deliverability risk. ### POST /api/v1/campaigns/{campaignId}/test-email Send test email Send one email from a brand mailbox to check a step's copy, the same way the app's test email does. Personalization variables are filled in from one of the campaign's leads when it has any. The API key owner needs an admin role on the brand. Each API key can send 10 test emails a minute and 100 a day (UTC). Parameters: - `campaignId (path)` (string, required): Campaign ID. JSON body: - `send_to` (string, required): Address that receives the test email. - `subject` (string, required): Subject. Personalization variables are filled in from one of the campaign's leads. - `content` (string, required): Body as HTML. Personalization variables are filled in from one of the campaign's leads, and the sending mailbox's signature is appended. - `from_email_account_id` (string, required): Email account of the brand to send from. ### GET /api/v1/campaigns/{campaignId}/analytics/overview Get campaign analytics overview Get high-level performance metrics for a campaign including reply rate, engagement rate, and total leads contacted. Parameters: - `campaignId (path)` (string, required): Campaign ID. - `dateFrom (query)` (string, optional): Filter from date (ISO 8601) - `dateTo (query)` (string, optional): Filter to date (ISO 8601) - `channel (query)` (string, optional, one of: email, linkedin, twitter, instagram, whatsapp, telegram, slack, sms): Filter by channel ### GET /api/v1/campaigns/{campaignId}/analytics/channels Get channel breakdown Get performance metrics broken down by channel (email, LinkedIn, etc.). Parameters: - `campaignId (path)` (string, required): Campaign ID. - `dateFrom (query)` (string, optional): Filter from date (ISO 8601) - `dateTo (query)` (string, optional): Filter to date (ISO 8601) ### GET /api/v1/campaigns/{campaignId}/analytics/timeline Get campaign timeline Get time-series data showing campaign events over time, grouped by hour or day. Parameters: - `campaignId (path)` (string, required): Campaign ID. - `groupBy (query)` (string, optional, one of: hour, day): Group by hour or day - `dateFrom (query)` (string, optional): Filter from date (ISO 8601) - `dateTo (query)` (string, optional): Filter to date (ISO 8601) - `channel (query)` (string, optional, one of: email, linkedin, twitter, instagram, whatsapp, telegram, slack, sms): Filter by channel ### GET /api/v1/campaigns/{campaignId}/analytics/events List campaign activity events Paginated per-lead activity log for a campaign, newest first: sends, deliveries, opens, clicks, replies, bounces, LinkedIn connection requests and acceptances, profile visits, reactions, skips and failures. Each event carries the lead, the sending account and the channel it happened on. Parameters: - `campaignId (path)` (string, required): Campaign ID. - `page (query)` (number, optional): Page number (1-based) - `limit (query)` (number, optional): Number of items per page - `search (query)` (string, optional): Search query to filter results by name or email - `dateFrom (query)` (string, optional): Only events at or after this time (ISO 8601). - `dateTo (query)` (string, optional): Only events at or before this time (ISO 8601). - `channel (query)` (string, optional, one of: email, linkedin, twitter, instagram, whatsapp, telegram, slack, sms): Only events on this channel. - `eventType (query)` (string, optional, one of: sent, delivered, opened, clicked, replied, bounced, unsubscribed, spam_complaint, converted, failed, follow_request_sent, follow_request_accepted, follow_request_expired, connection_request_sent, connection_accepted, profile_visited, profile_visit_skipped, invitation_skipped, message_skipped, step_skipped, reaction_sent, reaction_skipped, sibling_reply_cancelled): Only events of this type. - `success (query)` (boolean, optional): true returns successful events only, false returns failures, bounces and skips only. - `accountId (query)` (string[], optional): Only events sent from these account IDs. Repeat the parameter to pass several. ### GET /api/v1/sending-accounts List sending accounts List the brand's email accounts and LinkedIn, X (Twitter), Instagram, WhatsApp and Telegram accounts that the key's issuer can use in campaigns, email accounts first, newest first, with whether each one can send now. Use the IDs with the link sending accounts endpoint. ### GET /api/v1/webhooks/endpoints List webhook endpoints Retrieve all webhook endpoints configured for the current brand. ### POST /api/v1/webhooks/endpoints Create a webhook endpoint Create a new webhook endpoint. You can subscribe to specific event types and configure authentication, retries, and timeouts. A maximum of 10 endpoints per brand is allowed. JSON body: - `name` (string, required): Human-readable name for the webhook endpoint - `url` (string, required): Target URL that will receive webhook payloads - `method` (string, optional, one of: POST, PUT, PATCH): HTTP method used for delivery - `event_types` (string[], required, one of: mention.created, mention.updated, campaign.launched, campaign.completed, campaign.reply_received, campaign.activity, inbox.message_received, inbox.conversation_created, lead.created, lead.updated, lead.stage_changed, lead.imported, lead_collection.completed, email.domain_registered, email.domain_dns_verified, email.domain_dns_failed, email.mailbox_provisioned, llm_monitor.brand_mentioned, llm_monitor.brand_missing, integration.connected, integration.disconnected, billing.payment_succeeded, billing.payment_failed, billing.subscription_changed, credits.low, credits.depleted, team.member_invited, team.member_joined, team.member_removed): Event types this endpoint subscribes to. Use the `/event-types` endpoint to list all available types. - `auth_type` (string, optional, one of: none, bearer, basic, api_key, custom): Authentication method the endpoint expects - `auth_config` (object, optional): Authentication credentials. Required fields depend on `auth_type`: bearer requires `token`, basic requires `username`/`password`, api_key requires `apiKey` and `headerName`, custom requires `customHeaders`. - `headers` (object, optional): Extra HTTP headers sent with every delivery - `max_retries` (number, optional): Maximum retry attempts on failed delivery (0 = no retries) - `timeout_ms` (number, optional): Delivery timeout in milliseconds - `secret` (string, optional): Secret used to generate the HMAC-SHA256 signature in the `X-Webhook-Signature` header. If omitted, a random secret is generated. - `is_enabled` (boolean, optional): Whether the endpoint is enabled and will receive deliveries ### GET /api/v1/webhooks/endpoints/{endpointId} Get a webhook endpoint Retrieve details of a specific webhook endpoint. Parameters: - `endpointId (path)` (string, required): Webhook endpoint ID. ### PATCH /api/v1/webhooks/endpoints/{endpointId} Update a webhook endpoint Partially update an existing webhook endpoint. Only provided fields are changed. Parameters: - `endpointId (path)` (string, required): Webhook endpoint ID. JSON body: - `name` (string, optional): Human-readable name for the webhook endpoint - `url` (string, optional): Target URL that will receive webhook payloads - `method` (string, optional, one of: POST, PUT, PATCH): HTTP method used for delivery - `event_types` (string[], optional, one of: mention.created, mention.updated, campaign.launched, campaign.completed, campaign.reply_received, campaign.activity, inbox.message_received, inbox.conversation_created, lead.created, lead.updated, lead.stage_changed, lead.imported, lead_collection.completed, email.domain_registered, email.domain_dns_verified, email.domain_dns_failed, email.mailbox_provisioned, llm_monitor.brand_mentioned, llm_monitor.brand_missing, integration.connected, integration.disconnected, billing.payment_succeeded, billing.payment_failed, billing.subscription_changed, credits.low, credits.depleted, team.member_invited, team.member_joined, team.member_removed): Event types this endpoint subscribes to - `auth_type` (string, optional, one of: none, bearer, basic, api_key, custom): Authentication method the endpoint expects - `auth_config` (object, optional): Authentication credentials - `headers` (object, optional): Extra HTTP headers sent with every delivery - `max_retries` (number, optional): Maximum retry attempts on failed delivery (0 = no retries) - `timeout_ms` (number, optional): Delivery timeout in milliseconds - `secret` (string, optional): Secret used to generate the HMAC-SHA256 signature - `is_enabled` (boolean, optional): Whether the endpoint is enabled and will receive deliveries ### DELETE /api/v1/webhooks/endpoints/{endpointId} Delete a webhook endpoint Permanently delete a webhook endpoint. This cannot be undone. Parameters: - `endpointId (path)` (string, required): Webhook endpoint ID. ### PUT /api/v1/webhooks/endpoints/{endpointId}/toggle Toggle a webhook endpoint Enable or disable a webhook endpoint. Disabled endpoints stop receiving deliveries. Parameters: - `endpointId (path)` (string, required): Webhook endpoint ID. ### POST /api/v1/webhooks/endpoints/{endpointId}/test Test a webhook endpoint Send a test payload to a webhook endpoint to verify it is reachable and correctly configured. Parameters: - `endpointId (path)` (string, required): Webhook endpoint ID. JSON body: - `payload` (object, required): Custom payload to deliver to the endpoint - `event_type` (string, optional, one of: mention.created, mention.updated, campaign.launched, campaign.completed, campaign.reply_received, campaign.activity, inbox.message_received, inbox.conversation_created, lead.created, lead.updated, lead.stage_changed, lead.imported, lead_collection.completed, email.domain_registered, email.domain_dns_verified, email.domain_dns_failed, email.mailbox_provisioned, llm_monitor.brand_mentioned, llm_monitor.brand_missing, integration.connected, integration.disconnected, billing.payment_succeeded, billing.payment_failed, billing.subscription_changed, credits.low, credits.depleted, team.member_invited, team.member_joined, team.member_removed): Event type to include in the test delivery headers ### GET /api/v1/webhooks/stats Get webhook statistics Retrieve aggregated delivery statistics across all webhook endpoints for the current brand. ### GET /api/v1/webhooks/event-types List available event types Retrieve all webhook event types you can subscribe to, grouped by category. ## MCP tools 96 tools, in the order the MCP server lists them. ### brandjet_list_brands Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false List all brands accessible to the current user. Returns each brand's id, name, description, website, industry, and isActive status, plus the currently selected brandId. Do NOT use for brand settings or configuration (use brandjet_get_brand_settings instead). Parameters: none ### brandjet_switch_brand Annotations: readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: false Switch the active brand for this session only. A new session of a login with several brands starts with no brand selected, so call this first whenever a session must work on a specific brand. Jobs that run in parallel on different brands should pass brandId on each tool call instead, or connect with an API key, which always works on the brand it was created for. Parameters: - `brandId` (string, required): Brand ID to switch to. Must be one of the IDs returned by brandjet_list_brands. ### brandjet_create_brand Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Create a brand owned by the signed-in user, the same way adding a brand in the app does. It counts toward the plan's brand limit and is refused at the limit. The brand starts active with monitoring off: turn monitoring on with brandjet_manage_brand_settings (action toggle_monitoring). The session stays on its current brand, so call brandjet_switch_brand with the returned id to work on the new one. Needs a connection signed in through OAuth; API keys cannot create brands. Parameters: - `name` (string, required): Brand name, as its customers know it (1-255 characters). - `website` (string, required): Brand website, for example https://example.com. The name and the website domain become the brand keywords. - `platforms` (string[], optional, one of: twitter, reddit, youtube, news, linkedin, tiktok): Platforms to monitor once monitoring is on. Defaults to twitter, reddit, youtube, news and linkedin. ### brandjet_create_campaign Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Create a new outreach campaign for the current brand. Returns the campaign in DRAFT status. Optionally include a workflow definition with nodes and edges. For brand-new campaigns without attached leads, leave generated message configValues empty unless the user provided exact copy; add or revise message copy after leads are attached and exact variables are known. Parameters: - `name` (string, required): Campaign name (e.g., "Summer Outreach 2024") - `type` (string, required, one of: email_sequence, outreach, nurture, sales): Campaign type. "email_sequence" for email-only flows. "outreach" for LinkedIn, multi-channel, or general outreach. "nurture" for long-term engagement. "sales" for direct sales sequences. Use "outreach" for LinkedIn-focused campaigns. - `description` (string, optional): Campaign description - `priority` (string, optional, one of: low, medium, high, urgent): Priority level (default: medium) - `targetAudience` (string, optional): Description of target audience - `scheduledStartAt` (string, optional): Scheduled start date-time (ISO 8601) - `scheduledEndAt` (string, optional): Scheduled end date-time (ISO 8601) - `timezone` (string, optional): Timezone for sending schedule (e.g., "America/New_York") - `sendingDays` (string[], optional, one of: monday, tuesday, wednesday, thursday, friday, saturday, sunday): Days of week to send on - `sendingTimeStart` (string, optional): Daily sending window start (HH:MM format, e.g., "09:00") - `sendingTimeEnd` (string, optional): Daily sending window end (HH:MM format, e.g., "17:00") - `maxNewLeadsPerDay` (integer, optional): Maximum new leads to contact per day - `prioritizeNewLeads` (boolean, optional): Whether to prioritize new leads (default: false) - `respectTimezone` (boolean, optional): Whether to respect lead timezone for sending (default: false) - `trackOpens` (boolean, optional): Track email opens (default: true) - `trackClicks` (boolean, optional): Track email link clicks (default: true) - `trackUnsubscribes` (boolean, optional): Track unsubscribe events (default: false) - `includeUnsubscribeLink` (boolean, optional): Append a visible unsubscribe link to the email footer and send a one-click List-Unsubscribe header. Leave this off for 1-1 outreach, where the header can push mail into the Gmail Promotions tab; turn it on for marketing or high-volume sending (default: false) - `gdprCompliant` (boolean, optional): Add GDPR compliance footer and unsubscribe handling to every email in this campaign (default: false) - `canSpamCompliant` (boolean, optional): Add CAN-SPAM compliance footer and unsubscribe handling to every email in this campaign (default: false) - `stopSendingTrigger` (string, optional, one of: reply, click, open, bounce): Stop sending to a lead when this event occurs (default: reply) - `enableProviderMatching` (boolean, optional): Match email provider (e.g., Outlook to Outlook) (default: true) - `workflows` (object[], optional): Workflow definitions. Each campaign typically has one workflow. Include a "start" node and action nodes (email, linkedin, etc.) connected via edges. Add delays by setting sendWhen="delay" with delayValue+delayUnit on the action node — do NOT create separate delay/wait nodes. - `workflows[].name` (string, required): Workflow name (e.g., "Main Sequence") - `workflows[].description` (string, optional) - `workflows[].nodes` (object[], required): Workflow nodes. Must include exactly one "start" node. To add delays between steps, set sendWhen="delay" with delayValue+delayUnit on the action node itself. To A/B test a step, set variantDistribution and a "variants" array on that action node. - `workflows[].nodes[].nodeId` (string, required): Unique node identifier within the workflow (e.g., "node-1", "start-1") - `workflows[].nodes[].label` (string, required): Display label for the node - `workflows[].nodes[].type` (string, required, 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): Node type. Rules: (1) Every workflow must begin with exactly one "start" node. (2) Do NOT create separate delay/wait nodes — set sendWhen="delay" with delayValue+delayUnit on the action node. (3) "linkedin_invitation" = connection request, "linkedin" = direct message (requires existing connection). (4) For condition nodes, create two outgoing edges with label "No" (index 0) and "Yes" (index 1). For linkedin_invitation, use "Rejected" (index 0) and "Accepted" (index 1). - `workflows[].nodes[].status` (string, optional, one of: action_needed, configured, draft): Set to "configured" when the node has all required configurations filled in. Default: action_needed. - `workflows[].nodes[].channel` (string, optional, one of: email, linkedin, twitter, instagram, whatsapp, telegram, slack, sms): Required for action nodes. Set to match the node type: email→"email", linkedin/linkedin_invitation/linkedin_profile_visit/linkedin_reaction→"linkedin", twitter→"twitter", instagram→"instagram", whatsapp→"whatsapp", telegram→"telegram". - `workflows[].nodes[].positionX` (number, optional): Canvas X position for UI layout - `workflows[].nodes[].positionY` (number, optional): Canvas Y position for UI layout - `workflows[].nodes[].title` (string, optional): Alternative display title - `workflows[].nodes[].sendWhen` (string, optional, one of: send_immediately, delay): IMPORTANT: Set to "delay" on an action node to wait before executing it. This is how you add delays between steps — NOT by creating separate delay nodes. The first action node after "start" should use "send_immediately" or omit this field. Example: a linkedin message node with sendWhen="delay", delayValue=2, delayUnit="days" will wait 2 days after the previous step before sending. - `workflows[].nodes[].delayValue` (number, optional): How long to wait before executing this node (used when sendWhen="delay") - `workflows[].nodes[].delayUnit` (string, optional, one of: minutes, hours, days, weeks): Time unit for delayValue (minutes, hours, days, weeks) - `workflows[].nodes[].configurations` (object[], optional): Node-specific configuration key-value pairs. When the node has A/B variants, these act as the shared defaults that each variant's configs override per key. - `workflows[].nodes[].configurations[].configKey` (string, required): Configuration key. Exact keys per node type: email→"subject","content","followUpToNodeId" (set followUpToNodeId to the nodeId of a previous email node to thread replies); linkedin→"message"; linkedin_invitation→REQUIRES BOTH "invitationNote" (200 char max including rendered personalization variables; LinkedIn rejects longer notes on non-Premium accounts) AND "timeWindowHours" (hours to wait before checking acceptance, e.g. "48" for 2 days, "72" for 3 days; never omit, otherwise the node falls back to the 72 hour default); linkedin_reaction→"reactionType" (one of: like, celebrate, support, love, insightful, funny); twitter→"message"; instagram→"message","followRequestTimeoutHours" (hours to wait for private account follow acceptance, default 168); whatsapp→"message"; telegram→"message" - `workflows[].nodes[].configurations[].configValue` (string, optional): Configuration value. For message templates, use personalization variables with snake_case syntax: {{lead_name}}, {{first_name}}, {{last_name}}, {{lead_email}}, {{lead_phone}}, {{brand_name}}, {{sender_name}}, {{mention_content}}, {{mention_platform}}, {{mention_url}}, {{mention_sentiment}}, {{mention_date}}. Custom variables: {{custom.variable_name}} (e.g., {{custom.company_name}}). Only use placeholders returned by brandjet_get_campaigns with includeVariables=true when configuring an existing campaign. Do not invent helper expressions or camelCase variables like {{firstName}} or {{companyName}} because they fail validation. - `workflows[].nodes[].configurations[].dataType` (string, optional): Optional data type hint - `workflows[].nodes[].variantDistribution` (string, optional, one of: equal, manual, auto_optimize): Enables A/B testing on this action node when set together with "variants". "equal" splits leads evenly across active variants; "manual" routes by each variant's weight; "auto_optimize" uses Thompson sampling on variantWinningMetric to shift traffic toward the better performer and declares a winner once every variant has at least variantMinSampleSize sends and one leads with 95% probability. - `workflows[].nodes[].variantWinningMetric` (string, optional, one of: reply_rate, positive_reply_rate, click_rate, connection_acceptance_rate): Metric used to compare variants and pick a winner. "reply_rate" or "positive_reply_rate" for message steps, "click_rate" for tracked email links, "connection_acceptance_rate" for linkedin_invitation nodes. Used by variantDistribution="auto_optimize"; defaults to "reply_rate". - `workflows[].nodes[].variantMinSampleSize` (integer, optional): Minimum sends per variant before a winner can be declared under "auto_optimize". Default: 100. - `workflows[].nodes[].variants` (object[], optional): A/B test variants for this action node (email, linkedin, linkedin_invitation, twitter, instagram, whatsapp, telegram). Provide at least two, each with a unique single-letter variantKey. Put the shared copy in node "configurations" and only the differing keys (e.g., "subject", "content", "message", "invitationNote") in each variant's configs. Set variantDistribution on the node when using variants. Omit entirely for a node with no A/B test. Per-variant results are not exposed through the MCP analytics tools yet; view them on the campaign Analytics page in the app. - `workflows[].nodes[].variants[].variantKey` (string, required): Single uppercase letter identifying the variant ("A", "B", "C", ...). Must be unique within the node. Use "A" for the control. - `workflows[].nodes[].variants[].weight` (number, optional): Share of leads routed to this variant, 0-100. Only used when the node has variantDistribution="manual"; weights across the node's variants should sum to 100. Default: 50. - `workflows[].nodes[].variants[].isControl` (boolean, optional): Mark exactly one variant per node as the control (baseline). Default: false. - `workflows[].nodes[].variants[].senderAccountId` (string, optional): Optional: send this variant from a specific account instead of the campaign rotation. Must be an account already linked to the campaign (see brandjet_list_campaign_resources). Set senderAccountType alongside it. - `workflows[].nodes[].variants[].senderAccountType` (string, optional, one of: email, social, mailbox): Type of senderAccountId: "email" for email accounts, "social" for LinkedIn/Twitter/Instagram/WhatsApp/Telegram integrations, "mailbox" for managed mailboxes. - `workflows[].nodes[].variants[].delayValue` (number, optional): Optional: override the node-level delayValue for this variant only (to test send timing). - `workflows[].nodes[].variants[].delayUnit` (string, optional, one of: minutes, hours, days, weeks): Time unit for the variant delayValue override - `workflows[].nodes[].variants[].configs` (object[], optional): Variant-specific configuration overrides using the same configKey/configValue pairs as node "configurations" (e.g., a different "subject" or "content" for email, a different "message" for linkedin). Keys not listed here fall back to the node-level configurations, so only include the keys this variant changes. - `workflows[].edges` (object[], required): Edges connecting nodes by their nodeId. - `workflows[].edges[].edgeId` (string, required): Unique edge identifier within the workflow - `workflows[].edges[].sourceNodeId` (string, required): Source node nodeId - `workflows[].edges[].targetNodeId` (string, required): Target node nodeId - `workflows[].edges[].label` (string, optional): Edge label. For condition nodes: "No" (index 0) or "Yes" (index 1). For linkedin_invitation: "Rejected" (index 0) or "Accepted" (index 1). Must be capitalized. - `workflows[].edges[].condition` (string, optional): Condition logic expression - `workflows[].edges[].isActive` (boolean, optional): Whether this edge is active (default: true) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_campaigns Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get campaigns for the current brand. Without campaignId: lists all campaigns. With campaignId: returns full details, optionally including workflow, lead stats, and linked accounts. Use brandjet_get_team_members to resolve ownerId into a readable name/email. Parameters: - `campaignId` (string, optional): Campaign ID. If provided, returns full details. If omitted, lists all campaigns for the current brand. - `includeWorkflow` (boolean, optional): Include workflow definition with nodes and edges (only when campaignId is provided, default: false) - `includeVariables` (boolean, optional): Include available personalization variables for message templates. Returns exact placeholder strings like {{first_name}}, {{lead_name}}, {{brand_name}}, and custom variables from campaign leads such as {{custom.company_name}}. Use this before configuring a workflow to know exactly which placeholders are valid. (only when campaignId is provided, default: false) - `includeLeadStats` (boolean, optional): Include lead statistics by channel (only when campaignId is provided, default: false) - `includeAccounts` (boolean, optional): Include linked sending accounts (only when campaignId is provided, default: false) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_campaign_analytics Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get aggregate campaign analytics for the current brand or a single campaign. Use this for questions like "how many emails did we send today?", "sent count this week", "replies yesterday", or channel-level outreach performance. Returns direct sent counts and channel breakdowns so you do not need to page through execution logs. Parameters: - `campaignId` (string, optional): Optional campaign ID. Omit to aggregate across every campaign in the current brand workspace. - `timeframe` (string, optional, one of: today, yesterday, last_7_days, last_30_days, custom): Time range shortcut. Use "today" for questions like "how many emails did we send today?". Use "custom" with dateFrom/dateTo for a specific range. Default: today. - `dateFrom` (string, optional): Custom start date in YYYY-MM-DD or ISO format. Only needed when timeframe is custom. - `dateTo` (string, optional): Custom end date in YYYY-MM-DD or ISO format, inclusive. Only needed when timeframe is custom. - `channel` (string, optional, one of: email, linkedin, twitter, instagram, whatsapp, telegram, slack, sms): Optional channel filter. Use "email" for email-specific send counts, "linkedin" for LinkedIn outreach, etc. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_list_campaign_resources Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false List all available resources for building campaigns: lead lists, email accounts, and integration accounts (LinkedIn, Twitter, etc.) for the current brand. Call this before configuring a campaign to see what is available. Lists the email accounts and LinkedIn, X (Twitter), Instagram, WhatsApp and Telegram accounts you can use in campaigns. Each account includes canSend (bool) and canSendReason (email: error | disconnected | pending | reply_tracking_disabled; integrations: disabled | error | inactive | pending | requires_review | rate_limited; null when it can send) so you can filter unhealthy accounts without combining raw status + isEnabled yourself. Parameters: - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_configure_campaign Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Configure a campaign by adding leads, linking sending accounts, and/or setting the workflow. Each section is optional. Leads are additive (merged with existing). Accounts default to replace mode — account selection MUST be operator-confirmed via accounts.confirmed: true. Call brandjet_list_campaign_resources first to see the brand's full sendable pool before attaching accounts. Call brandjet_get_campaigns with includeVariables=true before writing message templates; invalid placeholders are rejected. Workflow is fully replaced. Lead list IDs and lead IDs must come from a brandjet_get_lead_lists or brandjet_get_leads call made in this same conversation turn; stale or invented IDs are rejected with a not-found error. Related tools: brandjet_campaign_action (launch after configuring), brandjet_get_campaigns (view current config). Parameters: - `campaignId` (string, required): Campaign ID to configure - `settings` (object, optional): Campaign-level settings. Every field here can be changed on an existing campaign, including maxNewLeadsPerDay and the sending schedule — never create a duplicate campaign just to change a setting. Applied before the leads block in the same call. - `settings.verifiedOnly` (boolean, optional): When true, unverified leads are filtered out when attaching lists or ID sets. Applied before the leads block so attachments in this same call respect it. Defaults to false; reliable verification requires a future verifier integration. - `settings.name` (string, optional): Rename the campaign - `settings.description` (string, optional): Campaign description - `settings.priority` (string, optional, one of: low, medium, high, urgent): Priority level - `settings.targetAudience` (string, optional): Description of target audience - `settings.maxNewLeadsPerDay` (integer, optional): Daily cap on how many new leads the campaign starts contacting. Change this here; it does not require creating a new campaign. - `settings.prioritizeNewLeads` (boolean, optional): Prioritise new leads over follow-ups when the daily cap is reached - `settings.timezone` (string, optional): Timezone for the sending schedule (e.g., "America/New_York") - `settings.sendingDays` (string[], optional, one of: monday, tuesday, wednesday, thursday, friday, saturday, sunday): Days of week to send on - `settings.sendingTimeStart` (string, optional): Daily sending window start (HH:MM, e.g., "09:00") - `settings.sendingTimeEnd` (string, optional): Daily sending window end (HH:MM, e.g., "17:00") - `settings.respectTimezone` (boolean, optional): Respect each lead timezone when sending - `settings.trackOpens` (boolean, optional): Track email opens - `settings.trackClicks` (boolean, optional): Track email link clicks - `settings.trackUnsubscribes` (boolean, optional): Track unsubscribe events - `settings.includeUnsubscribeLink` (boolean, optional): Append a visible unsubscribe link to the email footer and send a one-click List-Unsubscribe header. Leave this off for 1-1 outreach, where the header can push mail into the Gmail Promotions tab; turn it on for marketing or high-volume sending - `settings.gdprCompliant` (boolean, optional): Add GDPR compliance footer and unsubscribe handling to every email in this campaign - `settings.canSpamCompliant` (boolean, optional): Add CAN-SPAM compliance footer and unsubscribe handling to every email in this campaign - `settings.stopSendingTrigger` (string, optional, one of: reply, click, open, bounce): Stop sending to a lead when this event occurs - `settings.enableProviderMatching` (boolean, optional): Match email provider (e.g., Outlook to Outlook) - `settings.scheduledStartAt` (string, optional): Scheduled start date-time (ISO 8601) - `settings.scheduledEndAt` (string, optional): Scheduled end date-time (ISO 8601) - `leads` (object, optional): Leads to add to the campaign. Multiple methods can be combined in one call. - `leads.fromListIds` (string[], optional): Add leads from these lead list IDs - `leads.qualifiedOnly` (boolean, optional): With fromListIds: add only leads the AI qualification marked as qualified (customVariables.qualification_status = "qualified") - `leads.byIds` (string[], optional): Add specific lead IDs directly - `leads.manual` (object[], optional): Manually defined leads to create and add, up to 500 per call. Leads are matched to existing brand leads by email, phone or profile URL, so re-sending the same lead never creates a duplicate. - `leads.manual[].name` (string, optional): Lead name - `leads.manual[].email` (string, optional): Lead email address - `leads.manual[].phoneNumber` (string, optional): Lead phone number - `leads.manual[].linkedinProfileUrl` (string, optional): LinkedIn profile URL - `leads.manual[].twitterProfileUrl` (string, optional): Twitter/X profile URL - `leads.manual[].instagramProfileUrl` (string, optional): Instagram profile URL - `leads.manual[].customVariables` (object, optional): Custom personalization variables as key-value pairs - `accounts` (object, optional): Sending accounts to link to the campaign. Account selection MUST be operator-confirmed. Pass accounts.confirmed: true to apply changes. - `accounts.accountIds` (string[], optional): Specific email account or integration IDs to link - `accounts.selectAll` (boolean, optional): Select all brand accounts matching the type/provider filters - `accounts.type` (string, optional, one of: email, social): Filter accounts by type (used with selectAll) - `accounts.provider` (string, optional, one of: google, outlook, smtp, twitter, linkedin, instagram, whatsapp): Filter accounts by provider (used with selectAll) - `accounts.replace` (boolean, optional): Replace existing accounts (true) or merge with existing (false). Default: true - `accounts.confirmed` (boolean, optional): Required true to apply account changes when narrowing or replacing the active sender pool. Without it, a preview of the proposed change is returned. Always call brandjet_list_campaign_resources first to see the full sendable pool. - `workflow` (object, optional): Replace the campaign workflow entirely. The full workflow (nodes + edges) must be provided. - `workflow.name` (string, required): Workflow name (e.g., "Main Sequence") - `workflow.description` (string, optional) - `workflow.nodes` (object[], required): Workflow nodes. Must include exactly one "start" node. To add delays between steps, set sendWhen="delay" with delayValue+delayUnit on the action node itself. To A/B test a step, set variantDistribution and a "variants" array on that action node. - `workflow.nodes[].nodeId` (string, required): Unique node identifier within the workflow (e.g., "node-1", "start-1") - `workflow.nodes[].label` (string, required): Display label for the node - `workflow.nodes[].type` (string, required, 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): Node type. Rules: (1) Every workflow must begin with exactly one "start" node. (2) Do NOT create separate delay/wait nodes — set sendWhen="delay" with delayValue+delayUnit on the action node. (3) "linkedin_invitation" = connection request, "linkedin" = direct message (requires existing connection). (4) For condition nodes, create two outgoing edges with label "No" (index 0) and "Yes" (index 1). For linkedin_invitation, use "Rejected" (index 0) and "Accepted" (index 1). - `workflow.nodes[].status` (string, optional, one of: action_needed, configured, draft): Set to "configured" when the node has all required configurations filled in. Default: action_needed. - `workflow.nodes[].channel` (string, optional, one of: email, linkedin, twitter, instagram, whatsapp, telegram, slack, sms): Required for action nodes. Set to match the node type: email→"email", linkedin/linkedin_invitation/linkedin_profile_visit/linkedin_reaction→"linkedin", twitter→"twitter", instagram→"instagram", whatsapp→"whatsapp", telegram→"telegram". - `workflow.nodes[].positionX` (number, optional): Canvas X position for UI layout - `workflow.nodes[].positionY` (number, optional): Canvas Y position for UI layout - `workflow.nodes[].title` (string, optional): Alternative display title - `workflow.nodes[].sendWhen` (string, optional, one of: send_immediately, delay): IMPORTANT: Set to "delay" on an action node to wait before executing it. This is how you add delays between steps — NOT by creating separate delay nodes. The first action node after "start" should use "send_immediately" or omit this field. Example: a linkedin message node with sendWhen="delay", delayValue=2, delayUnit="days" will wait 2 days after the previous step before sending. - `workflow.nodes[].delayValue` (number, optional): How long to wait before executing this node (used when sendWhen="delay") - `workflow.nodes[].delayUnit` (string, optional, one of: minutes, hours, days, weeks): Time unit for delayValue (minutes, hours, days, weeks) - `workflow.nodes[].configurations` (object[], optional): Node-specific configuration key-value pairs. When the node has A/B variants, these act as the shared defaults that each variant's configs override per key. - `workflow.nodes[].configurations[].configKey` (string, required): Configuration key. Exact keys per node type: email→"subject","content","followUpToNodeId" (set followUpToNodeId to the nodeId of a previous email node to thread replies); linkedin→"message"; linkedin_invitation→REQUIRES BOTH "invitationNote" (200 char max including rendered personalization variables; LinkedIn rejects longer notes on non-Premium accounts) AND "timeWindowHours" (hours to wait before checking acceptance, e.g. "48" for 2 days, "72" for 3 days; never omit, otherwise the node falls back to the 72 hour default); linkedin_reaction→"reactionType" (one of: like, celebrate, support, love, insightful, funny); twitter→"message"; instagram→"message","followRequestTimeoutHours" (hours to wait for private account follow acceptance, default 168); whatsapp→"message"; telegram→"message" - `workflow.nodes[].configurations[].configValue` (string, optional): Configuration value. For message templates, use personalization variables with snake_case syntax: {{lead_name}}, {{first_name}}, {{last_name}}, {{lead_email}}, {{lead_phone}}, {{brand_name}}, {{sender_name}}, {{mention_content}}, {{mention_platform}}, {{mention_url}}, {{mention_sentiment}}, {{mention_date}}. Custom variables: {{custom.variable_name}} (e.g., {{custom.company_name}}). Only use placeholders returned by brandjet_get_campaigns with includeVariables=true when configuring an existing campaign. Do not invent helper expressions or camelCase variables like {{firstName}} or {{companyName}} because they fail validation. - `workflow.nodes[].configurations[].dataType` (string, optional): Optional data type hint - `workflow.nodes[].variantDistribution` (string, optional, one of: equal, manual, auto_optimize): Enables A/B testing on this action node when set together with "variants". "equal" splits leads evenly across active variants; "manual" routes by each variant's weight; "auto_optimize" uses Thompson sampling on variantWinningMetric to shift traffic toward the better performer and declares a winner once every variant has at least variantMinSampleSize sends and one leads with 95% probability. - `workflow.nodes[].variantWinningMetric` (string, optional, one of: reply_rate, positive_reply_rate, click_rate, connection_acceptance_rate): Metric used to compare variants and pick a winner. "reply_rate" or "positive_reply_rate" for message steps, "click_rate" for tracked email links, "connection_acceptance_rate" for linkedin_invitation nodes. Used by variantDistribution="auto_optimize"; defaults to "reply_rate". - `workflow.nodes[].variantMinSampleSize` (integer, optional): Minimum sends per variant before a winner can be declared under "auto_optimize". Default: 100. - `workflow.nodes[].variants` (object[], optional): A/B test variants for this action node (email, linkedin, linkedin_invitation, twitter, instagram, whatsapp, telegram). Provide at least two, each with a unique single-letter variantKey. Put the shared copy in node "configurations" and only the differing keys (e.g., "subject", "content", "message", "invitationNote") in each variant's configs. Set variantDistribution on the node when using variants. Omit entirely for a node with no A/B test. Per-variant results are not exposed through the MCP analytics tools yet; view them on the campaign Analytics page in the app. - `workflow.nodes[].variants[].variantKey` (string, required): Single uppercase letter identifying the variant ("A", "B", "C", ...). Must be unique within the node. Use "A" for the control. - `workflow.nodes[].variants[].weight` (number, optional): Share of leads routed to this variant, 0-100. Only used when the node has variantDistribution="manual"; weights across the node's variants should sum to 100. Default: 50. - `workflow.nodes[].variants[].isControl` (boolean, optional): Mark exactly one variant per node as the control (baseline). Default: false. - `workflow.nodes[].variants[].senderAccountId` (string, optional): Optional: send this variant from a specific account instead of the campaign rotation. Must be an account already linked to the campaign (see brandjet_list_campaign_resources). Set senderAccountType alongside it. - `workflow.nodes[].variants[].senderAccountType` (string, optional, one of: email, social, mailbox): Type of senderAccountId: "email" for email accounts, "social" for LinkedIn/Twitter/Instagram/WhatsApp/Telegram integrations, "mailbox" for managed mailboxes. - `workflow.nodes[].variants[].delayValue` (number, optional): Optional: override the node-level delayValue for this variant only (to test send timing). - `workflow.nodes[].variants[].delayUnit` (string, optional, one of: minutes, hours, days, weeks): Time unit for the variant delayValue override - `workflow.nodes[].variants[].configs` (object[], optional): Variant-specific configuration overrides using the same configKey/configValue pairs as node "configurations" (e.g., a different "subject" or "content" for email, a different "message" for linkedin). Keys not listed here fall back to the node-level configurations, so only include the keys this variant changes. - `workflow.edges` (object[], required): Edges connecting nodes by their nodeId. - `workflow.edges[].edgeId` (string, required): Unique edge identifier within the workflow - `workflow.edges[].sourceNodeId` (string, required): Source node nodeId - `workflow.edges[].targetNodeId` (string, required): Target node nodeId - `workflow.edges[].label` (string, optional): Edge label. For condition nodes: "No" (index 0) or "Yes" (index 1). For linkedin_invitation: "Rejected" (index 0) or "Accepted" (index 1). Must be capitalized. - `workflow.edges[].condition` (string, optional): Condition logic expression - `workflow.edges[].isActive` (boolean, optional): Whether this edge is active (default: true) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_campaign_action Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Perform an action on a campaign: launch (start executing), pause (stop execution), resume (continue after pause), or remove_leads (take the leads in leadIds out of the campaign and cancel their remaining sequence steps, e.g. when a lead books a meeting). Launch, resume and remove_leads require confirmed: true to actually fire. Without it (or with dryRun: true), a preview is returned instead. When the launch preview includes warmupRisk (a sending mailbox has warmup off or is under day 14), the launch also requires acknowledgeWarmupRisk: true after the human operator accepts that risk. Always review the preview before confirming. Related tools: brandjet_get_campaigns (view status), brandjet_configure_campaign (set up before launch), brandjet_get_campaign_executions (view execution logs after launch). Parameters: - `campaignId` (string, required): Campaign ID - `action` (string, required, one of: launch, pause, resume, remove_leads): Action to perform on the campaign. "remove_leads" takes the leads in leadIds out of the campaign and cancels any sequence steps still pending for them, e.g. once a lead books a meeting. - `selectAll` (boolean, optional): Launch for all campaign leads. Defaults to false when leadIds is given and to true otherwise. Only used with "launch" action. - `leadIds` (string[], optional): Specific lead IDs. With "launch", the leads to launch for; the reply then estimates leadsStartingToday, leadsWaitingForNextWindow (leads the campaign cannot start today because of its daily new lead limit, its sending accounts or its sending schedule; they start automatically from the next sending window as capacity allows) and leadsAlreadyStarted. With "remove_leads" (required), the leads to take out of the campaign. - `scheduledStartAt` (string, optional): ISO 8601 datetime to schedule the launch. If omitted, launches immediately. Only used with "launch" action. - `timezone` (string, optional): Timezone for the sending schedule (e.g., "America/New_York"). Only used with "launch" action. - `dryRun` (boolean, optional): If true, validate and preview the launch without sending. Returns total leads, capacity preview, account health, and any blockers/warnings. Only used with "launch" action. Strongly recommended before the first real launch of a campaign. - `confirmed` (boolean, optional): Required true to actually execute a launch, resume or remove_leads. When omitted or false, the tool auto-routes to a preview (same as dryRun) and returns needsConfirmation: true. Pass confirmed: true after reviewing the preview to fire. - `acknowledgeDeliverabilityRisk` (boolean, optional): Required true (in addition to confirmed) to resume a campaign that was auto-paused for reputation risk (high bounce/complaint rate). Only pass after the human operator has explicitly accepted the deliverability risk shown in the preview. - `acknowledgeWarmupRisk` (boolean, optional): Required true (in addition to confirmed) to launch when the preview reports warmupRisk, meaning a linked sending mailbox has warmup off or is under day 14 of warmup. Only pass after the human operator has explicitly accepted the spam-placement risk listed in the preview; never set it on your own. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_campaign_lead_analytics Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get campaign lead analytics for the current campaign. Returns paginated lead workflow progress, execution status, current step, per-step metrics, and errors. Use this for questions about stuck leads, failed steps, lead progress, and why a campaign is not advancing. Parameters: - `campaignId` (string, required): Campaign ID - `page` (integer, optional): Page number (default: 1) - `limit` (integer, optional): Results per page (default: 25, max: 50) - `search` (string, optional): Search leads by name or email - `status` (string, optional, one of: pending, running, completed, failed, cancelled, paused): Filter by execution status - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_campaign_executions Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get paginated execution steps across all leads in a campaign. Each row includes the step status, workflow node, and delivery events (sentAt, deliveredAt, openedAt, clickedAt, repliedAt, bouncedAt). Filter by status, channel, nodeId, leadId, or sinceDate. Related tools: brandjet_get_campaigns (campaign overview), brandjet_get_lead_timeline (per-lead activity log). Parameters: - `campaignId` (string, required): Campaign ID - `page` (integer, optional): Page number (default: 1) - `limit` (integer, optional): Results per page (default: 50, max: 100) - `status` (string, optional, one of: pending, processing, completed, failed, skipped, waiting_follow_acceptance, waiting_connection_acceptance): Filter by execution step status - `channel` (string, optional, one of: email, linkedin, twitter, instagram, whatsapp, telegram, sms): Filter by channel - `nodeId` (string, optional): Filter by workflow node ID - `leadId` (string, optional): Filter by lead ID - `sinceDate` (string, optional): ISO 8601 date to filter steps scheduled/executed after this date - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_create_mention_to_outreach_workflow Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Wire up a complete social-listening-to-outreach pipeline in one call: watch for mentions matching a query, optionally filter by sentiment/intent, and prepare matched authors for human-approved enrollment into an outreach campaign by default. Use approvalMode=auto_enroll_paused_campaign only when the user explicitly wants automatic enrollment into a paused campaign. Examples: create a paused campaign for "founders complaining about Hootsuite" on Reddit/X; wire negative LinkedIn mentions into an existing campaignId with enrichment; dry-run a buying-intent workflow before creating resources. Parameters: - `listeningQuery` (string, required): Mention query or topic to monitor, e.g. "founders complaining about Hootsuite". - `platforms` (string[], optional, one of: twitter, x, reddit, youtube, news, linkedin, tiktok, hacker_news): Platform filters. "x" maps to twitter. Hacker News is accepted for intent but currently reported as unsupported until connected. Defaults to all enabled brand platforms. - `filters` (object, optional): Optional sentiment and intent filters. - `filters.sentimentTypes` (string[], optional, one of: positive, negative, neutral, mixed): Only trigger for these sentiment labels. - `filters.intentTypes` (string[], optional, one of: buyer, buying_signal, switching, pain_point, seller, neutral, general_discussion, self_promotion): Only trigger for these mention intent labels. - `filters.buyerIntentOnly` (boolean, optional): Shortcut for buyer, buying_signal, switching, and pain_point intents. - `filters.onlyNeedsResponse` (boolean, optional): When true, fetched mentions must still be marked needs_response before enrollment. - `campaignId` (string, optional): Existing campaign ID to enroll matched mention authors into. Mutually exclusive with campaign. - `campaign` (object, optional): Inline campaign spec to create and wire. Mutually exclusive with campaignId. - `campaign.name` (string, required): Campaign name to create. - `campaign.description` (string, optional): Optional campaign description. - `campaign.type` (string, optional, one of: email_sequence, outreach, nurture, sales): Campaign type. Defaults to outreach. - `campaign.priority` (string, optional, one of: low, medium, high, urgent): Campaign priority. Defaults to medium. - `campaign.targetAudience` (string, optional): Target audience description. - `campaign.subject` (string, optional): Default email subject when sequence is omitted. - `campaign.messageTemplate` (string, optional): Default first-step message when sequence is omitted. - `campaign.channel` (string, optional, one of: email, linkedin, twitter, instagram, whatsapp, telegram): Default outreach channel for generated sequence. Defaults to email. - `campaign.sequence` (object[], optional): Optional sequence steps. If omitted, one step is generated from messageTemplate. - `campaign.sequence[].channel` (string, optional, one of: email, linkedin, twitter, instagram, whatsapp, telegram): Outbound channel for this step. Defaults to the campaign channel. - `campaign.sequence[].subject` (string, optional): Email subject for email steps. - `campaign.sequence[].messageTemplate` (string, required): Message copy. Mention variables are available as {{custom.mention_content}}, {{custom.mention_platform}}, and {{custom.mention_url}}. - `campaign.sequence[].delayValue` (integer, optional): Delay before this step. Omit for the first immediate step. - `campaign.sequence[].delayUnit` (string, optional, one of: minutes, hours, days, weeks): Delay unit for delayValue. - `campaign.sendingAccounts` (object, optional): Sending accounts to link to the new campaign. - `campaign.sendingAccounts.accountIds` (string[], optional): Specific email account or integration IDs to link. - `campaign.sendingAccounts.selectAll` (boolean, optional): When true, link every healthy account matching type/provider. - `campaign.sendingAccounts.type` (string, optional, one of: email, social): Filter for selectAll. - `campaign.sendingAccounts.provider` (string, optional, one of: google, outlook, smtp, twitter, linkedin, instagram, whatsapp, reddit, youtube, telegram): Provider filter for selectAll. - `campaign.sendingAccounts.replace` (boolean, optional): Replace existing sending accounts. Defaults to true. - `campaign.schedule` (object, optional): Optional sending schedule. - `campaign.schedule.timezone` (string, optional): IANA timezone, e.g. America/New_York. - `campaign.schedule.sendingDays` (string[], optional, one of: monday, tuesday, wednesday, thursday, friday, saturday, sunday): Days allowed for sending. - `campaign.schedule.sendingTimeStart` (string, optional): Daily sending window start, HH:MM. - `campaign.schedule.sendingTimeEnd` (string, optional): Daily sending window end, HH:MM. - `campaign.schedule.maxNewLeadsPerDay` (integer, optional): Maximum new leads to contact per day. - `campaign.initialStatus` (string, optional, one of: draft, paused): Initial campaign state after creation. Defaults to paused for review. - `approvalMode` (string, optional, one of: require_approval, auto_enroll_paused_campaign): Controls whether matched mention authors pause for approval before enrollment. Defaults to require_approval. Use auto_enroll_paused_campaign only when the user explicitly wants automatic enrollment into the paused campaign. - `enrichAuthors` (boolean, optional): When true, run lead enrichment after each matched author is enrolled. Defaults to false. - `dryRun` (boolean, optional): When true, validate and return the planned resources without creating anything. Defaults to false. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_conversations Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get conversations for the current brand. Without conversationId: lists conversations with rich filtering (channel, status, search, pinned, starred, unread, time range, priority, tags, etc.). To count conversations that received an inbound reply during a calendar range, use countOnly with inboundDateFrom and inboundDateTo; these bounds filter actual inbound message sent time rather than last conversation activity. With conversationId: returns full conversation details including lead, campaign, tags, and participants. Use includeStats to get inbox statistics. Related tools: brandjet_get_messages (view full message thread for a conversation), brandjet_manage_automations (configure inbox automation rules), brandjet_get_team_members (resolve assignedToUserId to a readable name/email). Parameters: - `conversationId` (string, optional): Conversation ID. If provided, returns full details including lead, campaign, tags, and participants. If omitted, lists conversations with filters. - `includeStats` (boolean, optional): Include inbox statistics (total, active, closed, unread counts, counts by channel and tag). Only applies when listing conversations. Default: false. - `countOnly` (boolean, optional): Return only the exact number of matching conversations. Use with inboundDateFrom and inboundDateTo to count conversations that received an inbound reply in that range. - `channel` (string, optional, one of: email, linkedin, twitter, instagram, whatsapp, slack, sms): Filter by communication channel - `status` (string, optional, one of: active, closed, snoozed, spam): Filter by conversation status - `search` (string, optional): Search in conversation subject, last message text, lead name and email, and participant names and emails. Participants include people who replied on a campaign thread from an address other than the lead email. - `isPinned` (boolean, optional): Filter for pinned conversations only - `isStarred` (boolean, optional): Filter for starred conversations only - `isArchived` (boolean, optional): Filter for archived conversations. Default shows non-archived. - `hasUnread` (boolean, optional): Filter for conversations with unread messages - `isUnassigned` (boolean, optional): Filter for unassigned conversations - `hasNoReply` (boolean, optional): Filter for conversations where the brand has not replied - `noInboundReply` (boolean, optional): Filter for outbound-only conversations (no inbound messages) - `hasInboundReply` (boolean, optional): Filter for conversations that have at least one inbound reply. A message from another address counts when it answers a message in the thread, unless it is an automatic reply or a delivery notice. - `timeFilter` (string, optional, 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): Time-based filter. "last_*" filters by last message time, "no_reply_*" filters by time since last reply. - `inboundDateFrom` (string, optional): Inclusive lower bound for actual inbound message sent time. Must be an ISO 8601 timestamp with a UTC designator or numeric offset. - `inboundDateTo` (string, optional): Exclusive upper bound for actual inbound message sent time. Must be an ISO 8601 timestamp with a UTC designator or numeric offset. - `priority` (string, optional, one of: high, medium, low): Filter by priority level - `tagName` (string, optional): Filter by tag name (ordinary labels) - `assignedToUserId` (string, optional): Filter by assigned user ID - `leadId` (string, optional): Filter by lead ID - `crmStageIds` (string[], optional): Pipeline stages, OR with no stage and not in CRM - `hasNoCrmStage` (boolean, optional): Linked contacts without a pipeline stage - `hasNoLead` (boolean, optional): Conversations not linked to CRM - `campaignId` (string, optional): Filter by campaign ID - `page` (integer, optional): Page number for pagination (default: 1) - `limit` (integer, optional): Items per page (default: 50, max: 100) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_update_conversation Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Update a conversation: change status, pin/unpin, star/unstar, archive, assign to a user, change priority, or mark as read. Use action="archive" to archive, action="mark_read" to mark as read, or action="update" (default) to change fields. Parameters: - `conversationId` (string, required): Conversation ID to update - `action` (string, optional, one of: update, archive, mark_read): Special action. "archive" archives the conversation. "mark_read" marks it and all messages as read. "update" (default) applies field updates. - `crmStageId` (string | null, optional): Pipeline stage of the linked contact - `expectedVersion` (integer, optional): Current linked contact stageVersion, required for stage changes - `reopenConfirmed` (boolean, optional) - `subject` (string, optional): Update the conversation subject - `status` (string, optional, one of: active, closed, snoozed, spam): Change conversation status - `isPinned` (boolean, optional): Pin or unpin the conversation - `isStarred` (boolean, optional): Star or unstar the conversation - `isArchived` (boolean, optional): Archive or unarchive the conversation - `assignedToUserId` (string, optional): Assign the conversation to a user by their user ID - `priority` (string, optional, one of: high, medium, low): Set the conversation priority - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_messages Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get messages within a specific conversation (paginated, oldest first). Without conversationId, returns only the unread message count for the brand. Do NOT use to list conversations (use brandjet_get_conversations). Parameters: - `conversationId` (string, optional): Conversation ID to get messages for. If omitted, returns the unread message count for the current brand. - `campaignId` (string, optional): Restrict messages to conversations belonging to this campaign - `page` (integer, optional): Page number (default: 1). Messages are ordered oldest-first. - `limit` (integer, optional): Messages per page (default: 50, max: 100) - `includeHtml` (boolean, optional): Also return htmlContent, the original HTML body of each message (null for non-email channels). Default false. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_send_message Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Send a reply message in an existing conversation. Supports email, LinkedIn, Twitter, Instagram, and WhatsApp. The message is routed through the appropriate channel integration based on the conversation channel. Pass draftId to send a reply draft, for example one saved by an auto_reply rule in draft mode. Email replies are rejected when the lead or any CC or BCC address is suppressed; brandjet_get_suppression_status checks addresses ahead of time. Parameters: - `conversationId` (string, required): Conversation ID to send the message in - `content` (string, optional): Message content (plain text). For email, this is the text version. Required unless draftId is given or, for email, htmlContent is given. - `htmlContent` (string, optional): HTML content for email messages. If provided, used as the email body. - `draftId` (string, optional): Send a reply draft from this conversation, such as one an auto_reply rule saved in draft mode (see get_logs). Its text is used unless content is given, and the draft is removed once sent. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_conversation_tags Annotations: readOnlyHint: false, destructiveHint: false, idempotentHint: false, openWorldHint: false Add or remove tags on a conversation. Tags label conversations (e.g., "support", "urgent"). Use action="add" with tagName, or action="remove" with tagId. Adding a tag runs enabled auto_reply rules that have runOnTagAdded and that tag as tagMatch. Adding a tag the conversation already has does nothing, so remove it first to run those rules again. Parameters: - `conversationId` (string, required): Conversation ID - `action` (string, required, one of: add, remove): Whether to add or remove a tag - `tagName` (string, optional): Tag name to add (required when action is "add") - `tagColor` (string, optional): Hex color for the tag (e.g., "#FF5733"). Only used when adding. - `tagId` (string, optional): Tag ID to remove (required when action is "remove"). Get tag IDs from brandjet_get_conversations. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_custom_views Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage custom inbox views for the current brand. Views are saved filter configurations. Actions: "list" (get all views including predefined), "create" (save a new view with filters), "update" (modify existing view), "delete" (remove a view). Parameters: - `action` (string, required, one of: list, create, update, delete): Action to perform on custom views - `viewId` (string, optional): View ID (required for "update" and "delete" actions) - `name` (string, optional): View name (required for "create") - `description` (string, optional): View description - `emoji` (string, optional): Emoji icon for the view - `sortOrder` (integer, optional): Display order among views - `filters` (object, optional): Filter configuration as JSON. Supports keys: status, channel, timeFilter, priority, hasUnread, isUnassigned, hasNoReply, isPinned, isStarred, tagName, search. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_automations Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage inbox automation rules. "list" returns all rules (optionally filtered by type) with their runs and failures over the last 7 days. "get" returns a single rule with the same stats. "create" creates a new rule. "update" updates fields. "toggle" enables/disables. "delete" removes a rule. "get_logs" returns execution audit logs. Rule types: auto_assign (round-robin assignment, optionally with a follow up task for the assignee through createTask, taskTitle and taskDueInMinutes), auto_reply (template or AI reply). The assignee is notified when a rule assigns a conversation, and brand owners and admins are alerted once a day when a rule fails. Pipeline progression is configured in the pipeline settings. auto_reply runs when a new inbound message arrives on a cold-inbox conversation that matches the rule label, channel, pipeline stage, reply intent and campaignIds after that message is classified. With runOnTagAdded it also runs when its tagMatch label is added to a single conversation (not in bulk). maxRepliesPerConversation limits how many auto-replies one conversation gets, and draftOnly saves replies as Unibox drafts instead of sending them. Each time a matching auto_reply rule runs, its outcome and reason are logged in get_logs. Related tools: brandjet_get_conversations (view conversations that trigger rules). Parameters: - `action` (string, required, one of: list, get, create, update, toggle, delete, get_logs): Action to perform on inbox automation rules. "list" returns all rules. "get" returns a single rule. "create" creates a new rule. "update" updates an existing rule. "toggle" enables/disables a rule. "delete" deletes a rule and preserves its historical logs. "get_logs" returns one row per auto_reply outcome (success, skipped, deduped or failed) with skippedReason or errorMessage. Rows with action "auto_reply_draft" were saved as drafts and include the draft when it still exists. - `ruleId` (string, optional): Rule ID (required for get, update, toggle, delete; optional filter for get_logs) - `type` (string, optional, one of: auto_assign, auto_reply): Rule type. Required for create. Used as filter for list. "auto_assign" round-robins assignment. "auto_reply" sends template or AI reply. - `name` (string, optional): Rule name (required for create) - `crmStageIds` (string[] | null, optional) - `replyIntentMatch` (string | null, optional) - `tagMatch` (string, optional): Only fire when the conversation has this tag (case-insensitive). Checked once per new inbound message, after that message has been auto-tagged. With runOnTagAdded, adding this tag to a conversation also runs the rule. Omit to match every conversation. - `campaignIds` (string[] | null, optional): Only fire for conversations that belong to one of these campaigns. Pass null or an empty array to match every campaign. - `campaignId` (string, optional): Shorthand for campaignIds with a single campaign. - `maxRepliesPerConversation` (integer | null, optional): auto_reply only. Stop auto-replying in a conversation once it has received this many auto-replies from any rule. 1 means reply once. null removes the limit. - `draftOnly` (boolean, optional): auto_reply only. Save each reply as a Unibox draft for the conversation assignee (or the brand owner when unassigned) instead of sending it. get_logs shows these rows with action "auto_reply_draft" and the draft. The draft owner can send it with brandjet_send_message and draftId. - `runOnTagAdded` (boolean, optional): auto_reply only. Also run this rule when its tagMatch tag is added to a single conversation, either in the conversation view or with brandjet_manage_conversation_tags. Tags added in bulk do not run it. It answers the latest inbound message unless that message was already answered. Requires tagMatch. - `createTask` (boolean, optional): auto_assign only. Also create a task for the new assignee, linked to the conversation. The assignee gets one notification naming the rule and the task. Requires taskTitle. - `taskTitle` (string | null, optional): auto_assign only. Title of the task the rule creates, like "Follow up". An open task with the same title on the conversation is not duplicated. - `taskDueInMinutes` (integer | null, optional): auto_assign only. When the created task is due, in minutes after the assignment (1440 is one day). null means no due date. - `channelMatch` (string, optional, one of: email, linkedin, twitter, instagram, whatsapp, slack, sms): Only fire for this channel (null = any channel) - `isEnabled` (boolean, optional): Whether the rule is active. Required for toggle. - `assignToUserIds` (string[], optional): User IDs for round-robin assignment (auto_assign rules) - `replyMode` (string, optional, one of: template, ai): Reply mode: "template" for fixed text, "ai" for AI-generated (auto_reply rules) - `templateContent` (string, optional): Template content when replyMode is "template" - `aiPrompt` (string, optional): AI instructions when replyMode is "ai". Besides these instructions the AI receives: brand name and description; the last 20 messages; lead name and first name; company; lead custom variables (contact, secret and internal data such as email, phone, address or qualification_status are left out); campaign name and ID; conversation tags; the rule tagMatch; and the latest inbound sender display name. On email the sender display name is never used as the lead name. Missing values are given as NONE and the AI is told not to guess them. Refer to these facts in plain words (e.g. "if the region custom variable is far-east"); {{placeholders}} are not substituted. - `delayMinutes` (integer, optional): Delay in minutes before an auto_reply is sent. Only one auto-reply per conversation is pending at a time: inbound messages that arrive while one is pending do not schedule another, and when several auto_reply rules match an inbound message, only the first by sortOrder runs. Once the reply is sent, the next inbound message gets its own reply. A reply is skipped if the latest inbound message was already answered, and each conversation gets at most 10 auto-replies per 24 hours. - `sortOrder` (integer, optional): Display order among rules - `conversationId` (string, optional): Filter logs by conversation (get_logs only) - `since` (string, optional): ISO 8601 date to filter logs since (get_logs only) - `limit` (integer, optional): Max logs to return (get_logs only, default: 50) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_tasks Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage Unibox tasks: the follow ups a team tracks next to its conversations. Tasks have a title, notes, status (todo, in_progress, done), an assignee, a team, a due date, an optional linked conversation and one level of subtasks. You only see tasks whose linked conversation you can open. Assigning a task notifies the assignee, and due and overdue reminders go out on their own. Use "summary" for a quick count, "list" to browse, and "create" with conversationId to add a follow up to a reply. Related tools: brandjet_get_conversations (find a conversationId), brandjet_get_team_members (resolve user IDs), brandjet_manage_teams (team IDs). Parameters: - `action` (string, required, one of: list, get, summary, create, update, complete, reopen, delete): Action on Unibox tasks. "list" returns tasks you can see, soonest due first. "get" returns one task with its subtasks. "summary" returns open task counts: assigned to you, created by you, all, unassigned and your overdue ones. "create" adds a task, linked to a conversation or as a subtask when given. "update" changes any field. "complete" marks a task done and "reopen" moves it back to to do. "delete" removes a task and its subtasks; only its creator or a brand admin can delete it. - `taskId` (string, optional): Task ID. Required for get, update, complete, reopen and delete. - `view` (string, optional, one of: mine, created, all): List only. "mine" is tasks assigned to you, "created" is tasks you created, "all" is every task you can see. Defaults to "mine", or to "all" when assigneeUserIds, unassigned, teamIds or conversationId is given. - `statuses` (string[], optional, one of: todo, in_progress, done): List only. Statuses to include. Defaults to open tasks (todo and in_progress), or every status when searching. - `assigneeUserIds` (string[], optional): List only. Tasks assigned to these users. Resolve names with brandjet_get_team_members. - `unassigned` (boolean, optional): List only. Include tasks with no assignee. - `teamIds` (string[], optional): List only. Tasks set to these teams. Get team IDs from brandjet_manage_teams. - `conversationId` (string | null, optional): List: tasks linked to this conversation. Create and update: link the task to this conversation, or null on update to unlink it. Subtasks always follow the conversation of their parent. - `overdue` (boolean, optional): List only. Only open tasks whose due date has passed. - `noDueDate` (boolean, optional): List only. Only tasks without a due date. - `dueAfter` (string, optional): List only. Tasks due at or after this time. - `dueBefore` (string, optional): List only. Tasks due at or before this time. - `search` (string, optional): List only. Match words in task titles. - `includeSubtasks` (boolean, optional): List only. Also return subtasks that have the same assignee as their parent. The app hides them under the parent, and so does this tool by default. - `sort` (string, optional, one of: due, newest, updated): List only. "due" (default) is soonest due first, "newest" is newest first, "updated" is most recently changed first. - `limit` (integer, optional): List only. Max tasks to return (default 50). - `offset` (integer, optional): List only. Number of tasks to skip, for paging. - `title` (string, optional): Task title. Required for create. - `description` (string | null, optional): Task notes in plain text, or null to clear. - `status` (string, optional, one of: todo, in_progress, done): Create and update. Task status. - `assigneeUserId` (string | null, optional): Who does the task. On create it defaults to you; pass null to leave it unassigned. On update pass a user ID to reassign or null to unassign. The assignee must be able to open the linked conversation. - `teamId` (string | null, optional): Team for the task, or null to clear. On create it defaults to the assignee's team when they are in exactly one team. - `dueAt` (string | null, optional): Due date and time in ISO 8601 with offset, or null to clear. For a day with no time, set dueAllDay to true and pass 23:59:59 of that day in the user's timezone, for example 2026-10-24T23:59:59+05:00. - `dueAllDay` (boolean, optional): True when the task is due on a day rather than at a time. - `parentTaskId` (string, optional): Create only. Make the new task a subtask of this task. Subtasks cannot have their own subtasks. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_teams Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage teams in the current brand. Teams group teammates, like Sales or Support, so tasks can be assigned, filtered and grouped by team. Anyone in the brand can list teams; creating, renaming, changing members and deleting need a brand owner or admin. People added to a team are notified. Related tools: brandjet_get_team_members (resolve user IDs), brandjet_manage_tasks (tasks by team). Parameters: - `action` (string, required, one of: list, create, update, delete): Action on teams, which group teammates so tasks can be assigned, filtered and grouped by team (like Sales or Support). "list" returns teams and their members. "create", "update" and "delete" need a brand owner or admin. Deleting a team keeps its tasks and only clears their team. - `teamId` (string, optional): Team ID. Required for update and delete. - `name` (string, optional): Team name, unique within the brand. Required for create. - `memberUserIds` (string[], optional): Create: the first members. Update: replaces the whole member list. Members must belong to the brand; resolve them with brandjet_get_team_members. - `addMemberUserIds` (string[], optional): Update only. Add these members and keep the others. - `removeMemberUserIds` (string[], optional): Update only. Remove these members and keep the others. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_snippets Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage snippets: saved replies teammates insert by typing / in a Unibox reply, with variables that fill in per contact. Use them to keep answers consistent, like pricing, booking a call or a gentle follow up. Related tools: brandjet_send_message (send a reply), brandjet_manage_automations (rules that reply on their own). Parameters: - `action` (string, required, one of: list, get, create, update, delete): Action on snippets, the saved replies teammates insert by typing / in a Unibox reply. "list" returns the brand's snippets. "get" returns one. "create", "update" and "delete" change them. Names are unique within the brand. - `snippetId` (string, optional): Snippet ID. Required for get, update and delete. - `search` (string, optional): List only. Match snippet names. - `name` (string, optional): Snippet name. Required for create. - `content` (string, optional): Snippet text. Required for create. These variables fill in per contact when the snippet is inserted: {{first_name}}, {{last_name}}, {{company_name}}, {{job_title}}, {{email}}, {{phone}}, {{sender_name}} and {{sender_email}}. - `category` (string | null, optional): List: only this category. Create and update: group the snippet under this category, or null to clear it. - `channel` (string | null, optional): List: snippets for this channel, including those for every channel. Create and update: limit the snippet to one channel, or null for every channel. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_send_outreach_message Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Send a brand-new outbound message to one or more existing leads across email, LinkedIn, Twitter, Instagram, or WhatsApp. Creates a fresh Unibox conversation per lead. Always call once with confirmed=false first to get a preview (sender account, per-lead recipient + blockers, schedule), show it to the user, then re-call with confirmed=true to actually send. Bulk sends (leadIds.length > 1) are queued with a per-channel default spread so they trickle out gradually. Requires unibox:write scope. Distinct from brandjet_send_message, which replies inside an existing conversation. Parameters: - `idempotencyKey` (string, optional): Stable request key to reuse when retrying the same outreach request. Use a new key for a deliberate new message. - `channel` (string, required, one of: email, linkedin, twitter, instagram, whatsapp): Channel to send on. Each channel requires the lead to have the matching identifier (email for email; linkedinMetadata.providerId for LinkedIn; instagramMetadata.providerId for Instagram; whatsappMetadata.providerId or phoneNumber for WhatsApp; twitterMetadata.twitterUserId or twitterProfileUrl for Twitter). - `leadIds` (string[], required): Lead IDs to message (1-50). Use brandjet_get_leads or brandjet_advanced_filter_leads to find them. Each lead must already exist in this brand. - `content` (string, required): Plain-text message body. For email this is the text version (or the body when htmlContent is not provided). - `htmlContent` (string, optional): Optional HTML body. Email only. When provided it is used as the email body and sanitized for tracking pixels. - `subject` (string, optional): Email subject line. Email only. If omitted, a default outreach subject is generated. - `emailAccountId` (string, optional): Optional email account ID to send from. Email only. If omitted, the first connected email account for the brand is used. - `integrationId` (string, optional): Exact integration ID to send from for LinkedIn, Instagram, WhatsApp, and Twitter. Always provide it for new calls. Omission is supported only for backward compatibility and may select the legacy default account. - `spreadSeconds` (integer, optional): Seconds between each send when leadIds.length > 1. Defaults: email 60s, LinkedIn 300s, Twitter/Instagram/WhatsApp 180s. Use higher values for caution. - `confirmed` (boolean, optional): Must be true to actually send. When false or omitted, returns a dry-run preview only (sender account, per-lead eligibility, schedule). Always preview first, then resend with confirmed=true after the user approves. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_proposals Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false List proposals for the current brand with their signing status (draft, sent, viewed, signed, declined) and tracked deal value. Filter by lead, campaign, or status. Use this to answer "did they sign?", to find a proposal to send, or to report signed value. Requires proposals:read scope. Parameters: - `leadId` (string, optional): Filter proposals for one lead. - `campaignId` (string, optional): Filter proposals attributed to one campaign. - `status` (string, optional, one of: draft, sent, viewed, signed, declined, expired, voided): Filter by proposal status. - `page` (integer, optional): Page number, default 1. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_create_proposal Annotations: readOnlyHint: false, destructiveHint: false, idempotentHint: false, openWorldHint: false Create a signable proposal draft for a lead. The content is generated from a semantic spec (scope summary + deliverables + optional pricing) and autofilled with the lead's name, email, company, and title. Returns the draft with its id — it is NOT sent yet; follow up with brandjet_send_proposal. Requires proposals:write scope. Parameters: - `leadId` (string, required): The lead the proposal is for. The lead must have an email address. - `conversationId` (string, optional): Optional Unibox conversation to attribute the proposal to. Improves campaign attribution and signed-value tracking. - `title` (string, optional): Proposal title. Defaults to "Proposal for ". - `scopeSummary` (string, required): What the proposal is for, in plain language (20-500 chars). Semantic purpose only — no formatting instructions. - `deliverables` (string[], required): The concrete deliverables, one string each (1-12). - `priceAmount` (number, optional): Price shown in the proposal, USD. Also becomes the tracked deal value unless valueAmount is set. - `valueAmount` (number, optional): Tracked deal value in USD when different from the price. - `timeline` (string, optional): Optional timeline text. - `terms` (string, optional): Optional terms text. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_send_proposal Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Send a drafted proposal to its lead. When the lead has an existing email conversation, the proposal email goes out from the connected mailbox as a reply in that thread (deliveredVia: conversation); otherwise it is emailed directly (deliveredVia: email). The lead signs on a secure signing page and signing is tracked back into BrandJet. Always call once without confirmed to get a preview (recipient, subject, body, delivery route), show it to the user, then call again with confirmed: true to actually send. Requires proposals:write scope. Parameters: - `proposalId` (string, required): The proposal to send, from brandjet_get_proposals or brandjet_create_proposal. - `subject` (string, optional): Email subject. Placeholders like {document_title} and {client_company} are rendered at delivery. Defaults to a sensible subject. - `bodyHtml` (string, optional): Email body HTML. Placeholders like {client_first_name}, {document_url}, and {sender_name} are rendered at delivery. Defaults to a short delivery note. - `confirmed` (boolean, optional): Must be true to actually send. Call once without it to get a preview of what will be sent, show the user, then call again with confirmed: true. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_proposal Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Load one proposal in full: content sections, variables, signing status, deal value and outcome, plus engagement analytics (views, unique viewers, time on page, PDF downloads, reminders). Use this to answer "did they open it?" or before reminding or voiding. Requires proposals:read scope. Parameters: - `proposalId` (string, required): The proposal to load, from brandjet_get_proposals. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_remind_proposal Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Send a signing reminder for a proposal that is sent or viewed but not yet signed. Goes out in the original email thread when there is one, otherwise as a branded email. Reminders are rate-limited to one per hour per proposal. Call once without confirmed to check status and last reminder, then again with confirmed: true. Requires proposals:write scope. Parameters: - `proposalId` (string, required): The proposal awaiting signature to nudge. - `confirmed` (boolean, optional): Must be true to actually send the reminder. Without it, the proposal status and last reminder time are returned for the user to confirm. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_void_proposal Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Withdraw a sent proposal so its signing link stops working. The lead is emailed that it was withdrawn (with your optional reason). Drafts cannot be voided — delete them instead. Call once without confirmed to show the proposal, then again with confirmed: true. Requires proposals:write scope. Parameters: - `proposalId` (string, required): The sent proposal to withdraw. - `reason` (string, optional): Optional reason shared with the lead in the withdrawal email. - `confirmed` (boolean, optional): Must be true to actually void. Without it, the proposal is returned for the user to confirm. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_update_proposal_outcome Annotations: readOnlyHint: false, destructiveHint: false, idempotentHint: false, openWorldHint: false Record the business outcome of a proposal (won, lost, ghosted, or back to pending) with an optional reason. This is separate from the signing status and feeds win-rate reporting. Requires proposals:write scope. Parameters: - `proposalId` (string, required): The proposal to update. - `outcome` (string, required, one of: pending, won, lost, ghosted): Business outcome, independent of signing status. Signed proposals default to won and declined ones to lost. - `reason` (string, optional): Why the deal was won, lost, or went quiet. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_send_booking_link Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Mint a tracked booking link for a lead and optionally send it into their Unibox conversation. The link opens the acting user's booking page with the lead's details prefilled; when the lead books, the meeting is attributed back to the lead and campaign automatically. Call once without confirmed to preview the link and message; with confirmed: true and a conversationId the message is sent in the conversation. Requires meetings:write scope. Parameters: - `conversationId` (string, optional): The Unibox conversation to send the booking link in. Either this or leadId is required. - `leadId` (string, optional): The lead to mint the booking link for when there is no conversation. The link is returned for you to deliver. - `message` (string, optional): Message text to send with the link. Defaults to a short suggested message containing the link. - `confirmed` (boolean, optional): Must be true to actually send the message into the conversation. Without it, the minted link and suggested message are returned as a preview. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_meetings Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false List meetings for the current brand — booked by leads through booking links or added manually — with times, guests, status, and cancellation details. Requires meetings:read scope. Parameters: - `leadId` (string, optional): Filter meetings for one lead. - `upcoming` (boolean, optional): Only meetings that start in the future, soonest first. - `status` (string, optional, one of: confirmed, cancelled): Filter by status. Omit with upcoming: true to get confirmed meetings only. - `page` (integer, optional): Page number, default 1. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_cancel_meeting Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Cancel one of the acting user's upcoming meetings. The guest gets a cancellation email (with your optional note) and a link to pick a new time. Always call once without confirmed to show the meeting to the user, then call again with confirmed: true. Requires meetings:write scope. Parameters: - `meetingId` (string, required): The meeting to cancel, from brandjet_get_meetings. - `reason` (string, optional): Optional note shown to the guest in the cancellation email. - `confirmed` (boolean, optional): Must be true to actually cancel. Without it, the meeting details are returned for the user to confirm. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_create_meeting Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Add a meeting the user already scheduled with someone (for example agreed over the phone) so it appears on their BrandJet calendar, blocks the slot on their booking page, and is attributed to the lead. Optionally emails the guest a confirmation with a calendar invite. Requires meetings:write scope. Parameters: - `leadId` (string, optional): Lead to attribute the meeting to, when known. - `guestName` (string, required): Guest full name. - `guestEmail` (string, required): Guest email address. - `guestCompany` (string, optional): Guest company. - `title` (string, optional): Meeting title. - `startsAt` (string, required): Meeting start as an ISO 8601 timestamp with timezone offset, e.g. 2026-09-15T14:00:00Z. - `durationMinutes` (integer, optional): Length in minutes. Defaults to the calendar default duration. - `notes` (string, optional): Agenda or notes for the meeting. Shared with the guest in the confirmation email and calendar invite. - `sendInvite` (boolean, optional): Email the guest a confirmation with a calendar invite. Defaults to true. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_availability Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Read the acting user's booking calendar: whether bookings are on, the public booking URL, timezone, meeting length, buffers, notice, weekly hours, and date overrides. Use this before promising a lead a meeting time or to explain why a booking link is off. Requires meetings:read scope. Parameters: - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_lead_lists Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get lead lists for the current brand. Without leadListId: lists all lead lists with pagination and search. With leadListId: returns full details for that list. Optionally include shared pipeline stages and management statistics. Parameters: - `leadListId` (string, optional): Lead list ID. If provided, returns full details for that list. If omitted, lists all lead lists for the current brand. - `search` (string, optional): Search lead lists by name - `page` (integer, optional): Page number (default: 1) - `limit` (integer, optional): Items per page (default: 50, max: 100) - `includeStages` (boolean, optional): Include shared pipeline stage definitions for the brand (default: false) - `includeStats` (boolean, optional): Include lead management statistics — total leads, verified, unverified, lists count (default: false) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_leads Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get leads already in the brand's lead lists. With leadId: returns full details. With leadListId: returns leads in that list. Without either: returns all brand leads. List and detail responses include jobTitle, company, and linkedinProfileUrl for ICP qualification. For complex multi-condition queries, use brandjet_advanced_filter_leads instead. For CRM pipeline views, use brandjet_manage_crm_leads. Do NOT use to search external lead databases (use brandjet_search_lead_database). Use brandjet_get_team_members to resolve assignedTo user IDs into readable names/emails. Parameters: - `leadId` (string, optional): Lead ID. If provided, returns full lead details including pipeline stage, list, and social profiles. Use includeNotes to also fetch notes. - `leadListId` (string, optional): Filter leads within a specific lead list. Ignored when leadId is provided. - `search` (string, optional): Search leads by name or email - `crmStageId` (string, optional): Filter leads by pipeline stage ID - `verificationStatus` (string, optional, one of: verified, unverified): Filter by email verification status - `includeNotes` (boolean, optional): Include lead notes when fetching a single lead by leadId (default: false) - `includeEnrichmentData` (boolean, optional): Include enrichment data (enrichmentStatus, lastEnrichedAt, enrichmentData) when fetching a single lead by leadId (default: false) - `page` (integer, optional): Page number (default: 1) - `limit` (integer, optional): Items per page (default: 50, max: 100) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_create_lead Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Create a new lead list, or add/correct leads in an existing list. Use action="create_list" with listName to create an empty list. Use action="create_lead" with leadListId and lead details to add one lead. Use action="create_leads" with leadListId and leads[] to create up to 500 leads in one bulk call. Use action="upsert_leads" with leadListId and leads[] to match rows against existing brand leads by LinkedIn URL or email and update them in place, creating only the ones that do not already exist. Every lead requires a real name; never invent placeholder names such as "LinkedIn Profile 1". Always send the whole batch in a single call instead of one call per lead. Parameters: - `action` (string, required, one of: create_list, create_lead, create_leads, upsert_leads): Action to perform. "create_list" creates a new empty lead list. "create_lead" adds one lead. "create_leads" adds up to 500 leads in one bulk call. "upsert_leads" matches each row against existing brand leads by LinkedIn profile URL or email and updates those in place, creating only the rows that do not match. Use upsert_leads whenever you are correcting or re-importing leads that may already exist (for example replacing names on a list you imported earlier) — never loop brandjet_update_lead one lead at a time. - `listName` (string, optional): Name for the new lead list (required for "create_list") - `leadListId` (string, optional): Target lead list ID (required for "create_lead" and "create_leads") - `name` (string, optional): Lead full name (required for "create_lead"). Must be the real person name, never a placeholder. - `email` (string, optional): Lead email address - `phoneNumber` (string, optional): Lead phone number (E.164 format) - `linkedinProfileUrl` (string, optional): LinkedIn profile URL - `twitterProfileUrl` (string, optional): Twitter/X profile URL - `instagramProfileUrl` (string, optional): Instagram profile URL - `customVariables` (object, optional): Custom personalization variables as key-value pairs (e.g., {"company": "Acme", "role": "CTO"}) - `leads` (object[], optional): Lead payloads for "create_leads" and "upsert_leads". Max 500 per call. Send the whole batch in one call, not one lead per call. Example: [{"name":"Ada Lovelace","linkedinProfileUrl":"https://www.linkedin.com/in/ada"},{"name":"Alan Turing","email":"alan@example.com"}] - `leads[].name` (string, required): Lead full name. REQUIRED for every lead — the import is rejected if any row is missing it. Never substitute a placeholder such as "LinkedIn Profile 1" or "Unknown": BrandJet cannot derive a real name from a LinkedIn URL later, so a placeholder becomes permanent. If the source data has no name, stop and ask the user for one. - `leads[].email` (string, optional): Lead email address - `leads[].phoneNumber` (string, optional): Lead phone number (E.164 format) - `leads[].linkedinProfileUrl` (string, optional): LinkedIn profile URL - `leads[].twitterProfileUrl` (string, optional): Twitter/X profile URL - `leads[].instagramProfileUrl` (string, optional): Instagram profile URL - `leads[].customVariables` (object, optional): Custom personalization variables as key-value pairs - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_update_lead Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Update a single lead: modify fields or pipeline stage, add/delete notes, or delete the lead. For updating multiple leads at once, use brandjet_bulk_lead_operations instead. Parameters: - `expectedVersion` (integer, optional): Last observed stage version; reject a concurrent stage change. - `reopenConfirmed` (boolean, optional): Explicitly confirm moving out of a Won or Lost stage. - `leadId` (string, required): Lead ID to update - `action` (string, optional, one of: update, add_note, delete_note, delete): Action to perform. "update" (default) modifies lead fields and/or pipeline stage. "add_note" adds a note. "delete_note" removes a note. "delete" deletes the lead. - `name` (string, optional): Updated lead name (action: update) - `email` (string, optional): Updated email address (action: update) - `phoneNumber` (string, optional): Updated phone number (action: update) - `linkedinProfileUrl` (string, optional): Updated LinkedIn URL (action: update) - `twitterProfileUrl` (string, optional): Updated Twitter URL (action: update) - `instagramProfileUrl` (string, optional): Updated Instagram URL (action: update) - `customVariables` (object, optional): Updated custom variables (action: update) - `crmStageId` (string | null, optional): Set the shared pipeline stage. Null clears it. Use brandjet_manage_crm_stages to list stages. (action: update) - `noteContent` (string, optional): Note text to add (required for action: add_note) - `noteId` (string, optional): Note ID to delete (required for action: delete_note). Get note IDs from brandjet_get_leads with includeNotes. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_lead_lists Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage lead lists: update_list (rename), delete_list, merge_lists (combine several lists into one, deduplicating leads). Manage shared pipeline stages with brandjet_manage_crm_stages. Parameters: - `action` (string, required, one of: update_list, delete_list, merge_lists): Manage lead lists: update_list, delete_list, or merge_lists. Pipeline stages are managed with brandjet_manage_crm_stages. - `leadListId` (string, optional): Lead list ID (required for update_list, delete_list) - `name` (string, optional): New name for the lead list (action: update_list) - `listIds` (string[], optional): Lead list IDs to merge (required for merge_lists, at least 2). Every lead moves into the destination, cross-list duplicates are combined into one record, and the emptied lists are deleted. - `targetListId` (string, optional): Existing list that receives the leads (action: merge_lists). Usually one of listIds. Provide this or newListName. - `newListName` (string, optional): Create a new list with this name as the merge destination (action: merge_lists). Provide this or targetListId. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_lead_stats Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get lead analytics and statistics for the current brand. Always returns management stats (total leads, lead lists, verified, unverified). Optionally include verified/unverified distribution, pipeline stage counts, and lead list summaries. Parameters: - `includeDistribution` (boolean, optional): Include verified vs unverified lead distribution (default: false) - `includeStageStats` (boolean, optional): Include lead count per shared pipeline stage (default: false) - `includeListSummary` (boolean, optional): Include summary of all lead lists with counts (default: false) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_lead_collections Annotations: readOnlyHint: false, destructiveHint: false, idempotentHint: false, openWorldHint: false Manage automated lead scraping collections. "list" shows all collections. "status" checks progress. "create_linkedin" starts scraping from LinkedIn search. "create_instagram" starts scraping from an Instagram username or post. "pause/resume/retry/delete" control existing collections. Parameters: - `action` (string, required, one of: list, status, create_linkedin, create_instagram, pause, resume, retry, delete): Action to perform. "list" shows all collections. "status" checks a collection's progress. "create_linkedin" starts LinkedIn lead scraping from search. "create_instagram" starts Instagram lead scraping from a username or post. "pause/resume/retry/delete" control existing collections. - `collectionId` (string, optional): Collection ID (required for status, pause, resume, retry, delete) - `search` (string, optional): Search collections by name (action: list) - `page` (integer, optional): Page number (action: list, default: 1) - `limit` (integer, optional): Items per page (action: list, default: 50) - `searchQuery` (string, optional): Plain keyword search terms for the LinkedIn scraper (required for create_linkedin). This is NOT a URL: passing a linkedin.com/search or Sales Navigator link is rejected. Examples: "Southfield, Michigan, United States restaurants", "VP of Sales B2B SaaS San Francisco". If the user has an exact search URL, ask them to export it to CSV and import with brandjet_create_lead instead. - `collectionLimit` (integer, optional): Maximum number of leads to collect (required for create_linkedin and create_instagram) - `collectionName` (string, optional): Display name for the collection (action: create_linkedin) - `username` (string, optional): Instagram username to collect followers/following from (action: create_instagram) - `postLink` (string, optional): Instagram post URL to collect likes/comments from (action: create_instagram) - `collectFollowers` (boolean, optional): Collect followers of the username (action: create_instagram) - `collectFollowing` (boolean, optional): Collect following of the username (action: create_instagram) - `collectLikes` (boolean, optional): Collect likes on the post (action: create_instagram) - `collectComments` (boolean, optional): Collect comments on the post (action: create_instagram) - `leadListId` (string, optional): Target lead list to store collected leads in (action: create_linkedin, create_instagram) - `isContinuous` (boolean, optional): Run collection continuously with daily limits (action: create_linkedin, create_instagram, default: false) - `autoVerify` (boolean, optional): Automatically verify collected email addresses (action: create_linkedin, create_instagram, default: false) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_crm_stages Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage CRM pipeline stages for the current brand. "list" returns all stages with name, color, and position. "create" adds a new stage. "update" modifies a stage's name or color. "delete" removes a stage. "reorder" sets the display order by providing an ordered array of stage IDs. Parameters: - `outcome` (string, optional, one of: open, won, lost): Stage outcome for create or update. Won and Lost stop automatic progression. - `replacementStageId` (string | null, optional): Required for delete. Reassign leads to this stage, or explicitly null for No Stage. - `action` (string, required, one of: list, create, update, delete, reorder): Action to perform. "list" returns all CRM pipeline stages. "create" adds a new stage. "update" modifies a stage. "delete" removes a stage. "reorder" sets the display order of all stages. - `stageId` (string, optional): CRM stage ID (required for update, delete) - `name` (string, optional): Stage name (required for create, optional for update) - `color` (string, optional): Hex color for the stage, e.g. "#3498db" (optional for create, update) - `position` (integer, optional): Stage position in the pipeline (optional for create) - `stageIds` (string[], optional): Ordered array of all stage IDs to set display order (required for reorder) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_crm_leads Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage leads in the CRM pipeline. "update_stage" moves a lead to a CRM stage. "update_assignee" assigns a lead to a team member. "get_crm_leads" lists leads with CRM-specific filters (stage, assignee). "get_stage_stats" returns lead counts per stage. Do NOT use for general lead queries without CRM filters (use brandjet_get_leads or brandjet_advanced_filter_leads). Parameters: - `expectedVersion` (integer, optional): Last observed stage version for update_stage. - `reopenConfirmed` (boolean, optional): Explicitly confirm moving out of a Won or Lost stage. - `action` (string, required, one of: update_stage, update_assignee, get_crm_leads, get_stage_stats): Action to perform. "update_stage" moves a lead to a CRM stage. "update_assignee" assigns a lead to a user. "get_crm_leads" lists leads with CRM filters (stage, assignee). "get_stage_stats" returns lead counts per CRM stage. - `leadId` (string, optional): Lead ID (required for update_stage, update_assignee) - `crmStageId` (string | null, optional): CRM stage ID to move the lead to. Pass null to unset. (action: update_stage) - `assignedToId` (string | null, optional): User ID to assign the lead to. Pass null to unassign. (action: update_assignee) - `stageId` (string, optional): Filter leads by CRM stage (action: get_crm_leads) - `assigneeId` (string, optional): Filter leads by assignee (action: get_crm_leads) - `search` (string, optional): Search leads by name or email (action: get_crm_leads) - `page` (integer, optional): Page number (action: get_crm_leads, default: 1) - `limit` (integer, optional): Items per page (action: get_crm_leads, default: 50) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_advanced_filter_leads Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Filter existing leads with AND/OR conditions. Each field supports only the operators and value types declared in the schema. ID equality uses a UUID, ID membership uses a nonempty UUID array, and boolean equality requires true or false. Invalid or unsupported filters return an error. Use for complex queries that brandjet_get_leads cannot handle. Parameters: - `logic` (string, optional, one of: AND, OR): How to combine conditions: AND (all must match) or OR (any must match). Default: AND. - `conditions` (object[], required): Array of filter conditions (max 20). Available fields: name, email, phoneNumber, source, isVerified, crmStageId, assignedToId, leadListId, createdAt, updatedAt, hasEmail, hasPhone, hasLinkedin, hasTwitter, hasInstagram, hasTelegram, linkedinMetadata.company, linkedinMetadata.headline, linkedinMetadata.location, campaignId, hasReplied, inAnyCampaign. - `conditions[].field` (string | "source", required, one of: name, email, phoneNumber, linkedinMetadata.company, linkedinMetadata.headline, linkedinMetadata.location, crmStageId, assignedToId, leadListId, campaignId, isVerified, hasEmail, hasPhone, hasLinkedin, hasTwitter, hasInstagram, hasTelegram, hasReplied, inAnyCampaign, optedOut, createdAt, updatedAt) - `conditions[].operator` (string | "between", required, one of: equals, not_equals, contains, not_contains, starts_with, ends_with, is_empty, is_not_empty, in, not_in, is_true, is_false, gt, lt, gte, lte) - `conditions[].value` (string | any | string[] | boolean | object, optional) - `conditions[].value.from` (string, required) - `conditions[].value.to` (string, required) - `sortField` (string, optional, one of: name, email, createdAt, updatedAt, source): Field to sort results by - `sortOrder` (string, optional, one of: ASC, DESC): Sort direction (default: DESC) - `page` (integer, optional): Page number (default: 1) - `limit` (integer, optional): Items per page (default: 25, max: 200) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_bulk_lead_operations Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Perform bulk operations on multiple leads at once. "bulk_crm_stage" moves multiple leads to a shared pipeline stage. "bulk_assignee" assigns multiple leads. "bulk_delete" deletes leads by IDs or matching filters. For updating a single lead, use brandjet_update_lead instead. Confirm destructive actions before executing. Parameters: - `reopenConfirmed` (boolean, optional): Explicitly confirm moving selected leads out of Won or Lost stages. - `action` (string, required, one of: bulk_crm_stage, bulk_assignee, bulk_delete): "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. - `leadIds` (string[], optional): Lead IDs for bulk operations (required for bulk_crm_stage, bulk_assignee; optional for bulk_delete) - `crmStageId` (string | null, optional): CRM stage to assign. Null = unset. (required for bulk_crm_stage) - `assignedToId` (string | null, optional): User to assign leads to. Null = unassign. (required for bulk_assignee) - `deleteAllMatching` (boolean, optional): Delete all leads matching the filters below instead of specific IDs (action: bulk_delete) - `leadListId` (string, optional): Filter by lead list when using deleteAllMatching (action: bulk_delete) - `verificationStatus` (string, optional): Filter by verification status when using deleteAllMatching (action: bulk_delete) - `filterCrmStageId` (string, optional): Filter by pipeline stage when using deleteAllMatching (action: bulk_delete) - `search` (string, optional): Filter by search text when using deleteAllMatching (action: bulk_delete) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_lead_timeline Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get the per-lead activity timeline and sequence position. Returns chronological events (messages sent, opens, clicks, replies, executed workflow steps, status/CRM changes, notes, campaign enrollments, enrichment). Pass includeSummary:true to also receive current workflow step per active execution and the next scheduled action time. Supports pagination and filtering by event type (comma-separated). Parameters: - `leadId` (string, required): Lead ID to get activity timeline for - `page` (integer, optional): Page number (default: 1) - `limit` (integer, optional): Items per page (default: 25) - `type` (string, optional): Filter by event type (comma-separated). Supported: NOTE, CAMPAIGN_ADDED, CAMPAIGN_EXECUTION_STATUS, EXECUTION_STEP, CAMPAIGN_EVENT, EMAIL_EVENT, LINKEDIN_EVENT, TWITTER_EVENT, INSTAGRAM_EVENT, WHATSAPP_EVENT, TELEGRAM_EVENT, CONVERSATION_CREATED, STAGE_CHANGED - `includeSummary` (boolean, optional): If true, include a summary block with current workflow step per active execution and the next scheduled action (send/open/click) for the lead. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_suppression_status Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Check whether email addresses are suppressed for the current brand. Read-only. Works by address, so it also covers deleted or archived leads. Each result lists every match with its scope and reason: "brand" (this brand's suppression list: hard_bounce, unsubscribe, spam_complaint, manual, with suppressedAt), "global" (platform-wide address suppression) and "global_domain" (platform-wide domain suppression), both with reason "global" and suppressedAt null because they can come from other brands' events, and "brand_blocklist" (the brand's blocked domains). brand, global and global_domain matches block these emails to the address: campaign steps (a campaign's own CC or BCC is dropped from the step), new outreach (brandjet_send_outreach_message), replies in existing conversations (brandjet_send_message, drafts and scheduled replies, including CC and BCC), auto-replies, proposal signing requests and reminders, and workflow emails. brand_blocklist matches block the same emails except manual replies in an existing conversation and proposal emails; campaign sends also check the lead's company domain, which this lookup does not see. Campaign-only blocked domains are not included. Each address checked counts toward the brand's daily limit, shared with POST /v1/leads/suppression-check; plans without a daily API request limit have none. Requires leads:read scope. Parameters: - `emails` (string[], required): Email addresses to check (1-500). Matching is case-insensitive and does not require the address to belong to an existing lead. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_email_accounts Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get email accounts for the current brand. Without accountId: lists all email accounts with pagination and filtering by provider, status, and search. With accountId: returns full details for that specific account. Each response includes warmupReadiness: { isReady, daysWarmedUp, recommendedDailyLimit } so you can decide if the account is safe to use for cold outbound (isReady requires 30+ days warmed and status=CONNECTED with warmup ACTIVE). Parameters: - `accountId` (string, optional): Email account ID. If provided, returns full details for that account. If omitted, lists all email accounts for the current brand. - `provider` (string, optional, one of: google, outlook, azure, smtp): Filter by email provider (google, outlook, azure, smtp) - `status` (string, optional, one of: connected, disconnected, error, pending): Filter by account status (connected, disconnected, error, pending) - `search` (string, optional): Search by account name or email address - `page` (integer, optional): Page number (default: 1) - `limit` (integer, optional): Items per page (default: 50, max: 100) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_email_accounts Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage email account settings: update sending limits, signature, and display name; verify connection; delete accounts; or bulk operations. Does not support creation (email accounts must be connected through OAuth or SMTP in the app). For warmup management, use brandjet_manage_email_warmup instead. Parameters: - `action` (string, optional, one of: update, verify, delete, bulk_update_limits, bulk_delete): Action to perform. "update" (default) modifies account settings. "verify" tests the connection and updates status. "delete" removes the account. "bulk_update_limits" updates sending limits for multiple accounts. "bulk_delete" deletes multiple accounts. - `accountId` (string, optional): Email account ID (required for update, verify, delete) - `accountIds` (string[], optional): Email account IDs (required for bulk_update_limits, bulk_delete) - `name` (string, optional): Updated display name (action: update) - `replyToAddress` (string, optional): Updated reply-to email address (action: update) - `signature` (string, optional): Updated email signature HTML (action: update) - `bccToCrm` (string, optional): BCC email for CRM forwarding (action: update) - `dailyLimit` (integer, optional): Maximum emails per day (action: update, bulk_update_limits) - `hourlyLimit` (integer, optional): Maximum emails per hour (action: update, bulk_update_limits) - `minimumTimeGap` (integer, optional): Minimum minutes between emails (action: update, bulk_update_limits) - `randomAdditionalMinutes` (integer, optional): Random additional minutes between emails for human-like sending (action: update, bulk_update_limits) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_integrations Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get integrations for the current brand. Without integrationId: lists all integrations, optionally filtered by type or active-only. With integrationId: returns full details including platform-specific profile metadata (LinkedIn, Instagram, WhatsApp, Reddit). Parameters: - `integrationId` (string, optional): Integration ID. If provided, returns full details including platform-specific profile metadata. If omitted, lists all integrations for the current brand. - `type` (string, optional, one of: slack, discord, teams, webhook, twitter, instagram, reddit, youtube, linkedin, whatsapp): Filter by integration type (e.g., linkedin, twitter, instagram) - `activeOnly` (boolean, optional): If true, only return active and enabled integrations (default: false) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_integrations Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage integrations: update settings (action="update"), toggle enabled/disabled (action="toggle"), delete (action="delete"), or bulk delete (action="bulk_delete"). Does not support creation — integrations must be connected through the platform-specific OAuth flow in the app. Parameters: - `action` (string, required, one of: update, toggle, delete, bulk_delete): Action to perform. "update" modifies name, description, or enabled state. "toggle" flips enabled/disabled. "delete" removes the integration. "bulk_delete" removes multiple integrations. - `integrationId` (string, optional): Integration ID (required for update, toggle, delete) - `integrationIds` (string[], optional): Integration IDs (required for bulk_delete) - `name` (string, optional): Updated display name (action: update) - `description` (string, optional): Updated description (action: update) - `isEnabled` (boolean, optional): Enable or disable the integration (action: update) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_website_analytics Annotations: readOnlyHint: false, destructiveHint: false, idempotentHint: false, openWorldHint: false Manage website analytics configuration (setup, not data). Register a website for tracking, get/update config, remove tracking, get embed code, or regenerate the tracking key. Do NOT use to retrieve analytics data or statistics (use brandjet_get_website_analytics or brandjet_get_website_analytics_breakdown). Parameters: - `action` (string, required, one of: register, get_config, update, remove, get_embed_code, regenerate_key): Action to perform. "register" sets up website tracking (requires domain). "get_config" returns current config. "update" changes the website name. "remove" deletes the website. "get_embed_code" returns the tracking script. "regenerate_key" creates a new tracking key and embed code. - `domain` (string, optional): Website domain without protocol (required for register). Example: "example.com" - `name` (string, optional): Display name for the website (optional for register, used for update) - `timezone` (string, optional): Timezone for analytics data (optional for register, default: UTC). Example: "America/New_York" - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_website_analytics Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: true Get website analytics statistics and visitor data. Use "dashboard" for a full overview, or specific actions for individual metrics. Per-page, per-country, and per-referrer breakdowns expose visitors only (aggregate pageviews and bounce rate are surfaced on "main_stats"). Do NOT use for analytics configuration or setup (use brandjet_manage_website_analytics). For advanced breakdowns with filtering, use brandjet_get_website_analytics_breakdown. Parameters: - `action` (string, required, one of: dashboard, main_stats, visitors_chart, countries, pages, referrers, browsers, devices, check_events): Stat to retrieve. "dashboard" returns a full summary (main stats, visitors chart, top countries, pages, referrers, browsers, devices). "main_stats" returns core metrics (pageviews, visitors, bounce rate, visit duration, pages per visit) with period comparison. "visitors_chart" returns time-series visitor data. "countries/pages/referrers/browsers/devices" return specific breakdowns. "check_events" checks whether the tracking script has received any events. - `preset` (string, optional, one of: today, yesterday, last_7_days, last_30_days, last_90_days, this_month, last_month, custom): Date range preset (default: last_7_days). Use "custom" with startDate and endDate for a specific range. - `startDate` (string, optional): Start date in ISO format (required when preset is "custom"). Example: "2026-01-01" - `endDate` (string, optional): End date in ISO format (required when preset is "custom"). Example: "2026-01-31" - `granularity` (string, optional, one of: hour, day): Time granularity for chart data: "hour" or "day" - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_website_analytics_breakdown Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: true Get advanced website analytics breakdowns with optional filtering. Breakdowns include traffic channels, UTM campaigns, cities, entry pages, exit links, operating systems, and languages. Use filter parameters to narrow results (e.g., filter by country, browser, or referrer). Parameters: - `action` (string, required, one of: channels, campaigns, cities, entry_pages, exit_links, os, languages): Breakdown to retrieve. "channels" shows traffic channels (direct, organic, social, etc.) with top sources per channel. "campaigns" shows UTM campaign breakdown (campaign, source, medium). "cities" shows city-level geographic data. "entry_pages" shows first pages visited. "exit_links" shows external link clicks. "os" shows operating system distribution. "languages" shows visitor language distribution. All support optional filters to narrow results. - `preset` (string, optional, one of: today, yesterday, last_7_days, last_30_days, last_90_days, this_month, last_month, custom): Date range preset (default: last_7_days). Use "custom" with startDate and endDate for a specific range. - `startDate` (string, optional): Start date in ISO format (required when preset is "custom") - `endDate` (string, optional): End date in ISO format (required when preset is "custom") - `granularity` (string, optional, one of: hour, day): Time granularity: "hour" or "day" - `referrer` (string, optional): Filter by referrer source (e.g., "google.com") - `campaign` (string, optional): Filter by UTM campaign name - `page` (string, optional): Filter by page path (e.g., "/pricing") - `entryPage` (string, optional): Filter by entry page path - `country` (string, optional): Filter by country code (e.g., "US") - `city` (string, optional): Filter by city name - `browser` (string, optional): Filter by browser name (e.g., "Chrome") - `os` (string, optional): Filter by operating system (e.g., "Windows") - `language` (string, optional): Filter by language code (e.g., "en") - `channel` (string, optional): Filter by traffic channel (e.g., "organic", "direct", "social") - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_mentions Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: true Get individual brand mentions with full content, author, sentiment, and engagement data. Without mentionId: returns a paginated list with rich filtering — each row carries a competitor attribute (null for brand-owned mentions) so consumers can filter client-side. For a complete competitive brief, either iterate every competitor from brandjet_get_competitors calling this tool per competitorId, or call without competitorId/competitorIds/brandOnly to get brand + all competitor mentions in one paginated feed. Low mention volume for a competitor is itself a signal — never skip a competitor during a brief. With mentionId: returns full details including replies. Do NOT use for aggregate statistics (use brandjet_get_mention_stats) or sentiment analytics (use brandjet_get_sentiment_dashboard). Parameters: - `mentionId` (string, optional): Mention ID. If provided, returns full details for that mention including replies. If omitted, returns a paginated list of mentions with filters. - `platforms` (string[], optional, one of: twitter, reddit, youtube, news, linkedin, tiktok): Filter by platform(s). Example: ["twitter", "reddit"] - `sentimentType` (string, optional, one of: positive, negative, neutral, mixed): Filter by sentiment type - `status` (string, optional, one of: unread, read, archived, needs_response, responded): Filter by mention status (unread, read, archived, needs_response, responded) - `priority` (string, optional, one of: low, medium, high): Filter by mention priority (low, medium, high) - `search` (string, optional): Search within mention content (case-insensitive) - `matchedKeyword` (string, optional): Filter by the keyword that triggered this mention - `minEngagement` (integer, optional): Minimum engagement count filter - `isCrisisAlert` (boolean, optional): Filter for crisis alerts only - `brandOnly` (boolean, optional): When true, excludes competitor mentions and shows only brand-owned mentions (competitorId IS NULL). When omitted or false, returns brand + all competitor mentions together in one paginated feed. - `competitorId` (string, optional): Filter mentions for a specific competitor. Use this OR competitorIds, not both (competitorId wins if both are set). - `competitorIds` (string[], optional): Filter mentions across multiple competitors in one call. Mutually exclusive with competitorId. - `startDate` (string, optional): Filter mentions published after this ISO date. Example: "2026-01-01T00:00:00Z" - `endDate` (string, optional): Filter mentions published before this ISO date. Example: "2026-02-01T00:00:00Z" - `sortBy` (string, optional, one of: createdAt, publishedAt, engagementCount, sentimentScore, reachEstimate): Sort field (default: publishedAt) - `sortOrder` (string, optional, one of: ASC, DESC): Sort direction (default: DESC) - `page` (integer, optional): Page number (default: 1) - `limit` (integer, optional): Items per page (default: 20, max: 100) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_mention_stats Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get aggregate mention statistics (totals, by-platform, by-sentiment, engagement averages). Do NOT use to retrieve individual mention posts (use brandjet_get_mentions) or sentiment trends/drivers (use brandjet_get_sentiment_dashboard). Parameters: - `action` (string, required, one of: overview, counts, live): Stat type to retrieve. "overview" returns total mentions, by-platform, by-sentiment, recent 24h, and avg engagement. "counts" returns simple sentiment breakdown counts (positive, negative, neutral, total). "live" returns comprehensive real-time stats with platform distribution, top keywords, engagement metrics, and hourly trend data. - `timeframe` (string, optional, one of: 24h, 1w, lifetime): Timeframe for live stats (only used with action "live", default: "24h") - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_mentions Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage brand mentions. "update_status" changes a single mention's status. "bulk_update_status" changes status for multiple mentions. "bulk_delete" permanently deletes mentions. "delete_by_keyword" permanently deletes mentions collected for a matched keyword. "collect" triggers manual mention collection across all enabled platforms and returns per-platform counts, or status "running" when collection is still in progress after about 40 seconds (it keeps going in the background). Parameters: - `action` (string, required, one of: update_status, bulk_update_status, bulk_delete, delete_by_keyword, collect): Action to perform. "update_status" changes a single mention's status. "bulk_update_status" changes status for multiple mentions at once. "bulk_delete" permanently deletes multiple mentions. "delete_by_keyword" permanently deletes mentions collected for a matched keyword. "collect" triggers manual mention collection across all enabled platforms for the brand (may take time to complete). - `mentionId` (string, optional): Mention ID (required for update_status) - `mentionIds` (string[], optional): Array of mention IDs (required for bulk_update_status and bulk_delete) - `matchedKeyword` (string, optional): Matched keyword to delete mentions for (required for delete_by_keyword) - `competitorId` (string, optional): Competitor ID when deleting mentions for a competitor keyword - `status` (string, optional, one of: unread, read, archived, needs_response, responded): New status to set (required for update_status and bulk_update_status). Options: unread, read, archived, needs_response, responded. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_mention_reply Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Reply to brand mentions. "reply" posts a reply on the original platform. Requires confirmed: true to actually post; otherwise returns a preview. Twitter replies are temporarily disabled. Reddit and YouTube resolve the single active integration for the brand (socialAccountId is ignored). LinkedIn uses socialAccountId when multiple LinkedIn integrations are connected. "generate_ai_reply" generates an AI-powered reply suggestion (paid plans only). "get_replies" lists all replies for a mention. "delete_reply" removes a reply record. Parameters: - `action` (string, required, one of: reply, generate_ai_reply, get_replies, delete_reply): Action to perform. "reply" posts a reply to a mention on the original platform (Twitter is temporarily disabled; Reddit, YouTube, LinkedIn supported). "generate_ai_reply" generates an AI-powered reply suggestion based on the mention content and brand context (paid plans only). "get_replies" lists all replies posted for a specific mention. "delete_reply" removes a reply record. - `mentionId` (string, optional): Mention ID (required for reply, generate_ai_reply, get_replies) - `replyText` (string, optional): Text content of the reply (required for action "reply") - `socialAccountId` (string, optional): Specific integration account ID to use for the reply (LinkedIn only — Reddit and YouTube resolve the single active integration for the brand). Takes precedence over accountId when both are supplied. - `accountId` (string, optional): Deprecated alias for socialAccountId. Prefer socialAccountId in new code. - `confirmed` (boolean, optional): Required true for action "reply" to actually post. When omitted or false, returns a preview with needsConfirmation: true (no DB write, no platform call). Always review the preview before passing confirmed: true. - `replyId` (string, optional): Reply ID (required for delete_reply) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_sentiment_dashboard Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get computed sentiment analytics: distribution, trends, drivers, highlights, platform breakdowns, KPIs, and time-series charts. Returns analytical data, not individual mentions. Do NOT use to retrieve raw mention data (use brandjet_get_mentions) or simple mention counts (use brandjet_get_mention_stats). Parameters: - `action` (string, required, one of: dashboard, metrics, trends, drivers, highlights, platform_breakdown, chart, kpi): Dashboard view to retrieve. "dashboard" returns sentiment distribution with period-over-period comparison. "metrics" returns avg sentiment score, velocity, and response rate. "trends" returns daily sentiment trends over the timeframe. "drivers" returns top positive and negative sentiment drivers with themes and sample quotes. "highlights" returns significant sentiment shifts and trending topics across multiple timeframes. "platform_breakdown" returns per-platform mention counts with sentiment split. "chart" returns time-series chart data with sentiment scores and volume. "kpi" returns full KPI dashboard: total mentions, sentiment score, AI visibility score, and total reach with period comparisons. - `timeframe` (string, optional, one of: 1d, 3d, 7d, 14d, 30d): Analysis timeframe (default: "7d"). Not used for "highlights" action which analyzes across multiple timeframes automatically. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_shared_reports Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage public shared reports for brand monitoring data. "create" generates a new public report link with a chosen timeframe. "get" retrieves the currently active shared report. "revoke" deactivates the report, making the public link inaccessible. Parameters: - `action` (string, required, one of: create, get, revoke): Action to perform. "create" generates a new public shared report link for the brand. "get" retrieves the currently active shared report for this brand. "revoke" deactivates the active shared report, making the public link inaccessible. - `timeframe` (string, optional, one of: 24h, 7d, 30d): Report timeframe (required for "create", default: "7d") - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_agents Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get AI agents for the current brand. "list" returns paginated agents with execution stats and account assignments. "get" returns full details for a specific agent. "types" returns available agent types. Parameters: - `action` (string, required, one of: list, get, types): Action to perform. "list" returns paginated agents for the current brand with execution stats. "get" returns full details for a specific agent (requires agentId). "types" returns available agent types that can be created. - `agentId` (string, optional): Agent ID (required for "get" action) - `page` (integer, optional): Page number (default: 1, for "list" action) - `limit` (integer, optional): Items per page (default: 20, for "list" action) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_agents Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage AI agents. "create" creates a new agent. "update" modifies an agent. "delete" removes an agent. "activate"/"deactivate" toggle agent state. "duplicate" clones an agent. "scan" triggers manual mention scan. "generate_config" uses AI to generate configuration. Parameters: - `action` (string, required, one of: create, update, delete, activate, deactivate, duplicate, scan, generate_config): Action to perform. "create" creates a new AI agent. "update" modifies an existing agent. "delete" permanently deletes an agent. "activate" enables an agent. "deactivate" pauses an agent. "duplicate" clones an existing agent. "scan" triggers a manual mention scan. "generate_config" uses AI to generate agent configuration from natural language. - `agentId` (string, optional): Agent ID (required for update, delete, activate, deactivate, duplicate, scan) - `type` (string, optional, one of: mention_reply, lead_collector, conversation_reply): Agent type (required for "create") - `name` (string, optional): Agent name (required for "create") - `description` (string, optional): Agent description - `isActive` (boolean, optional): Whether agent should be active on creation - `requiresApproval` (boolean, optional): Whether agent replies need manual approval before posting - `personality` (object, optional): Agent personality configuration - `personality.role` (string, optional): Role the agent embodies (e.g., "Product Expert", "Community Manager") - `personality.name` (string, optional): Display name the agent uses when replying - `personality.tone` (string, optional, one of: professional, friendly, casual, formal, helpful, empathetic) - `personality.context` (string, optional): Background context about the brand or product the agent should know - `personality.additionalInstructions` (string, optional): Extra instructions for reply generation (e.g., "always include a CTA", "keep replies under 280 chars") - `conditions` (object, optional): Conditions for when the agent should act - `conditions.platforms` (string[], optional): Platforms to monitor: twitter, reddit, linkedin, youtube - `conditions.sentiment` (string[], optional): Sentiment types: positive, neutral, negative - `conditions.keywords` (string[], optional): Keywords that trigger responses - `conditions.excludeKeywords` (string[], optional): Keywords that prevent responses - `conditions.authorMinFollowers` (integer, optional): Only respond to authors with at least this many followers - `conditions.authorMaxFollowers` (integer, optional): Only respond to authors with at most this many followers - `conditions.authorVerifiedOnly` (boolean, optional): Only respond to verified or blue-check authors - `sampleReplies` (string[], optional): Sample replies for tone calibration - `newName` (string, optional): Name for the duplicated agent (for "duplicate" action) - `agentType` (string, optional, one of: mention_reply, lead_collector, conversation_reply): Agent type for AI generation (required for "generate_config") - `userContext` (string, optional): Natural language description of what the agent should do (required for "generate_config", max 2000 chars) - `targetLeadListId` (string, optional): Target lead list ID (for lead_collector agents) - `linkedCampaignId` (string, optional): Linked campaign ID (for lead_collector agents) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_agent_accounts Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage account assignments for AI agents. "list" shows all assignments. "assign" adds an account. "update" modifies priority/active. "remove" detaches an account. "stats" returns assignment statistics. Parameters: - `action` (string, required, one of: list, assign, update, remove, stats): Action to perform. "list" returns all account assignments for an agent. "assign" adds an integration account to the agent. "update" modifies an assignment priority or active status. "remove" detaches an account from the agent. "stats" returns aggregated account assignment statistics. - `agentId` (string, required): Agent ID (required for all actions) - `integrationId` (string, optional): Integration account ID (required for "assign" and "remove") - `assignmentId` (string, optional): Assignment ID (required for "update") - `priority` (integer, optional): Assignment priority (higher = preferred). Used with "assign" and "update". - `isActive` (boolean, optional): Whether the assignment is active. Used with "update". - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_agent_executions Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false View AI agent execution history, details, logs, and statistics. "list" returns paginated history with filters. "get" returns execution details. "logs" returns step logs. "by_agent"/"by_mention" return filtered executions. "stats" returns aggregated statistics. Parameters: - `action` (string, required, one of: list, get, logs, by_agent, by_mention, stats): Action to perform. "list" returns paginated execution history with filters. "get" returns full details for a specific execution. "logs" returns processing step logs for an execution. "by_agent" returns recent executions for a specific agent. "by_mention" returns all executions for a specific mention. "stats" returns execution statistics with success rate and status breakdown. - `executionId` (string, optional): Execution ID (required for "get" and "logs") - `agentId` (string, optional): Agent ID (required for "by_agent" and "stats", optional filter for "list") - `mentionId` (string, optional): Mention ID (required for "by_mention") - `status` (string, optional, one of: pending, evaluating, generating, awaiting_approval, executing, completed, failed, skipped, rate_limited): Filter by execution status (for "list" action) - `page` (integer, optional): Page number (default: 1) - `limit` (integer, optional): Items per page (default: 20) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_pending_replies Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage AI agent pending replies. "list" returns paginated replies with filters. "get" returns reply details. "approve" approves a reply (optionally with edits). "reject" rejects with reason. "bulk_approve"/"bulk_reject" for batch operations. "count" returns pending count. "badge_summary" returns per-agent breakdown. Parameters: - `action` (string, required, one of: list, get, approve, reject, bulk_approve, bulk_reject, count, badge_summary): Action to perform. "list" returns paginated pending replies with filters. "get" returns full details for a specific pending reply. "approve" approves a reply for posting (optionally with edited text). "reject" rejects a reply with optional reason. "bulk_approve" approves multiple replies. "bulk_reject" rejects multiple replies. "count" returns the number of pending approvals. "badge_summary" returns total pending count and per-agent breakdown. - `replyId` (string, optional): Pending reply ID (required for "get", "approve", "reject") - `replyIds` (string[], optional): Array of pending reply IDs (required for "bulk_approve", "bulk_reject") - `agentId` (string, optional): Filter by agent ID (for "list" action) - `status` (string, optional, one of: pending, approved, rejected, expired, executed, failed): Filter by status (for "list" action) - `editedText` (string, optional): Edited reply text to use instead of AI-generated text (for "approve") - `reason` (string, optional): Rejection reason (for "reject" and "bulk_reject") - `page` (integer, optional): Page number (default: 1, for "list" action) - `limit` (integer, optional): Items per page (default: 20, for "list" action) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_llm_monitors Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage LLM monitors that track brand visibility across AI models. Actions: list/get/create/update/delete monitors, plus retry_setup to re-run setup for a monitor stuck in setting_up. Monitor setup runs asynchronously after create_monitor: status transitions from setting_up to active, typically within two minutes. Do NOT use for personas (use brandjet_manage_personas), models (use brandjet_get_available_models), dashboard analytics (use brandjet_get_llm_dashboard), or query management (use brandjet_get_llm_queries or brandjet_manage_llm_queries). Parameters: - `action` (string, required, one of: list_monitors, get_monitor, create_monitor, update_monitor, delete_monitor, retry_setup): Action to perform. "list_monitors" lists all monitors for the brand. "get_monitor" returns full monitor details. "create_monitor" creates a new monitor. "update_monitor" modifies a monitor. "delete_monitor" removes a monitor. "retry_setup" re-runs setup for a monitor stuck in setting_up. - `monitorId` (string, optional): Monitor ID (required for get_monitor, update_monitor, delete_monitor, retry_setup) - `personaId` (string, optional): Persona ID (required for create_monitor) - `name` (string, optional): Name (for create/update monitor) - `description` (string, optional): Description (for create/update monitor) - `language` (string, optional): Language code, e.g. "en" (for create/update monitor) - `country` (string, optional): Country, e.g. "US" (for create/update monitor) - `initialPrompt` (string, optional): Initial prompt instructions (for create/update monitor) - `selectedModels` (string[], optional): Array of LLM model IDs to use (for create/update monitor) - `isActive` (boolean, optional): true activates the monitor (re-driving asynchronous setup when needed: status becomes setting_up, then active), false deactivates it (for update_monitor) - `runFrequency` (string, optional, one of: daily, weekly, monthly): How often every active question runs on each selected model: "daily", "weekly", or "monthly". Defaults to "weekly" on create_monitor; on update_monitor, each question is rescheduled from its last run (for create/update monitor) - `initialQueries` (object[], optional): User-reviewed queries to persist at creation; when provided, setup skips AI auto-generation (for create_monitor) - `initialQueries[].queryText` (string, required) - `initialQueries[].category` (string, optional, one of: direct_brand, competitor_comparison, industry_recommendations, problem_solving, sentiment_probing, use_case_specific, news_and_trends, technical_evaluation) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_personas Annotations: readOnlyHint: false, destructiveHint: false, idempotentHint: false, openWorldHint: false Manage buyer personas for LLM monitoring. Personas define target audience profiles used for query generation. Do NOT use for monitor management (use brandjet_manage_llm_monitors). Parameters: - `action` (string, required, one of: list, create, update, delete, suggest): Action to perform. "list" lists all personas for the brand. "create" creates a new persona. "update" modifies a persona. "delete" removes a persona. "suggest" uses AI to suggest a new persona configuration. - `personaId` (string, optional): Persona ID (required for update, delete) - `name` (string, optional): Persona name (required for create) - `description` (string, optional): Persona description - `ageRange` (string, optional): Persona age range: 18_24, 25_34, 35_44, 45_54, 55_64, 65_plus - `educationLevel` (string, optional): Persona education: high_school, bachelors, masters, doctorate, vocational, other - `excludeNames` (string[], optional): Names to exclude when suggesting a persona - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_available_models Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get the list of available LLM models that can be used for AI monitoring. Returns models grouped by platform. Parameters: - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_llm_dashboard Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get LLM monitoring dashboard analytics and insights. "summary" returns the monitoring overview for the selected brand. "insights" returns brand AI insights with sentiment and recommendations. "visibility_score" returns brand visibility trend over time. "model_statistics" returns per-model performance scores. "monitor_visibility" and "monitor_model_stats" return monitor-level analytics. Do NOT use to manage monitors or personas (use brandjet_manage_llm_monitors). Do NOT use to view individual queries (use brandjet_get_llm_queries). Parameters: - `action` (string, required, one of: summary, insights, visibility_score, model_statistics, monitor_visibility, monitor_model_stats): Action to perform. "summary" returns the monitoring summary for the selected brand. "insights" returns brand-level AI insights. "visibility_score" returns brand visibility over time. "model_statistics" returns per-model performance stats. "monitor_visibility" returns visibility for a specific monitor. "monitor_model_stats" returns model stats for a specific monitor. - `monitorId` (string, optional): Monitor ID (required for monitor_visibility, monitor_model_stats) - `days` (integer, optional): Number of days to look back (default: 7 for visibility, 30 for stats) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_llm_queries Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get LLM monitoring queries and responses. "list" returns paginated queries with filters (category, search, monitor, persona). "details" returns full query details with all responses and analysis. "responses" returns paginated responses. "blog_strategy" generates AI content recommendations based on query responses. Parameters: - `action` (string, required, one of: list, details, responses, blog_strategy): Action to perform. "list" returns paginated queries with filters. "details" returns full query details with responses and analysis. "responses" returns paginated responses with filters. "blog_strategy" generates AI-powered blog content recommendations based on query responses. - `queryId` (string, optional): Query ID (required for "details" and "blog_strategy") - `monitorId` (string, optional): Filter by monitor ID (for "list" and "responses") - `personaId` (string, optional): Filter by persona ID (for "list") - `days` (integer, optional): Days to look back (default: 7, valid: 7, 14, 30, 90) - `category` (string, optional): Filter by query category (for "list") - `search` (string, optional): Search text in queries or responses (for "list" and "responses") - `sortBy` (string, optional): Sort field: queryText, category, mentionCount, lastExecutedAt, createdAt (for "list") - `sortOrder` (string, optional, one of: ASC, DESC): Sort direction (default: DESC) - `mode` (string, optional, one of: full, minimal): Response mode: "full" includes responses, "minimal" is lighter (for "list") - `page` (integer, optional): Page number (default: 1) - `limit` (integer, optional): Items per page (default: 20) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_llm_queries Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage LLM monitoring queries. "bulk_activate" activates multiple queries. "bulk_deactivate" pauses queries. "bulk_delete" permanently removes queries. "create_custom" creates a custom monitoring query with optional immediate execution. Parameters: - `action` (string, required, one of: bulk_activate, bulk_deactivate, bulk_delete, create_custom): Action to perform. "bulk_activate" activates multiple queries. "bulk_deactivate" deactivates multiple queries. "bulk_delete" deletes multiple queries. "create_custom" creates a custom monitoring query. - `queryIds` (string[], optional): Array of query IDs (required for bulk_activate, bulk_deactivate, bulk_delete) - `monitorId` (string, optional): Monitor ID (required for "create_custom") - `queryText` (string, optional): Query text (required for "create_custom") - `category` (string, optional, one of: direct_brand, competitor_comparison, industry_recommendations, problem_solving, sentiment_probing, use_case_specific, news_and_trends, technical_evaluation): Query category (required for "create_custom") - `priority` (integer, optional): Priority 1-4: low, medium, high, critical (for "create_custom") - `queryLanguage` (string, optional): Language code for the query, e.g. "en-US" (for "create_custom") - `notes` (string, optional): Notes about the query (for "create_custom") - `executeImmediately` (boolean, optional): Execute query immediately after creation (default: true, for "create_custom") - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_competitors Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get competitors for the current brand. "list" returns all competitors with keywords, platforms, mention counts, and collection status. "get" returns full details for one competitor. "enhancement_status" returns enhancement pipeline progress. A complete competitive brief must always iterate every competitor returned here — low mention volume is itself a signal, never skip. Use brandjet_get_mentions with competitorIds[] or no competitor filter to retrieve the underlying mentions. Parameters: - `action` (string, required, one of: list, get, enhancement_status): Action to perform. "list" returns all competitors for the brand. "get" returns full details for a specific competitor (requires competitorId). "enhancement_status" returns enhancement pipeline progress (requires competitorId). - `competitorId` (string, optional): Competitor ID (required for "get" and "enhancement_status") - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_competitors Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage competitors. "create" adds a new competitor (plan limits apply). "update" modifies details. "delete" removes a competitor and all its data. "toggle_active" flips monitoring. "update_platforms" changes monitored platforms. Parameters: - `action` (string, required, one of: create, update, delete, toggle_active, update_platforms): "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. - `competitorId` (string, optional): Competitor ID (required for update, delete, toggle_active, update_platforms) - `name` (string, optional): Competitor name (required for "create", optional for "update") - `website` (string, optional): Competitor website URL - `logo` (string, optional): Competitor logo URL. Ignored unless it is an http(s) URL that fits the 255 character storage limit; an unusable value never blocks the competitor. - `platforms` (object, optional): Platform monitoring toggles. Each platform: true (monitor) or false (ignore). - `platforms.twitter` (boolean, optional) - `platforms.reddit` (boolean, optional) - `platforms.news` (boolean, optional) - `platforms.youtube` (boolean, optional) - `platforms.linkedin` (boolean, optional) - `platforms.tiktok` (boolean, optional) - `keywords` (object[], optional): Keywords to monitor (only for "update"). Replaces all existing keywords. - `keywords[].value` (string, required): Keyword to monitor - `keywords[].tag` (string, optional): Tag for categorization - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_competitor_action Annotations: readOnlyHint: false, destructiveHint: false, idempotentHint: false, openWorldHint: false Trigger async competitor actions. "enhance" starts the enhancement pipeline (website analysis, keyword generation, collection setup). "collect" triggers manual mention collection across enabled platforms. Parameters: - `action` (string, required, one of: enhance, collect): "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. - `competitorId` (string, required): Competitor ID - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_support_tickets Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get support tickets for the current user. Without ticketId: returns a paginated list with optional status and category filters. With ticketId: returns full ticket details including comments and attachments. Parameters: - `ticketId` (string, optional): Ticket ID. If provided, returns full ticket details including comments and attachments. If omitted, returns a paginated list of the user's tickets. - `status` (string, optional, one of: open, in_progress, awaiting_response, resolved, closed): Filter by ticket status - `category` (string, optional, one of: bug_report, feature_request, general_support): Filter by ticket category - `page` (integer, optional): Page number (default: 1) - `limit` (integer, optional): Items per page (default: 10, max: 100) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_create_support_ticket Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Create a new support ticket for the current user. Requires a subject, description, and category. Priority defaults to "medium" if not specified. Parameters: - `subject` (string, required): Ticket subject/title (max 255 characters) - `description` (string, required): Detailed description of the issue or request - `category` (string, required, one of: bug_report, feature_request, general_support): Ticket category. "bug_report" for bugs/errors, "feature_request" for new feature ideas, "general_support" for general help. - `priority` (string, optional, one of: low, medium, high, urgent): Ticket priority (default: "medium"). Use "urgent" only for critical production issues. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_support_tickets Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Add a comment to an existing support ticket. Only supports the "add_comment" action. Do NOT use to create new tickets (use brandjet_create_support_ticket) or to view tickets (use brandjet_get_support_tickets). Parameters: - `action` (string, required, one of: add_comment): Action to perform. "add_comment" adds a comment to an existing ticket. - `ticketId` (string, required): Ticket ID (required for all actions) - `content` (string, optional): Comment text content (required for add_comment) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_list_all_tools Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false List all available BrandJet MCP tools with their descriptions and categories. Use this to discover tools you might not know about. Filter by category to narrow results. Parameters: - `category` (string, optional): Filter by category (e.g., "campaigns", "leads", "unibox", "enrichment", "ai_agents", "mentions", "llm_monitoring", "website_analytics", "support", "brand", "integrations", "email_accounts", "navigation"). Omit to list all tools. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_user_settings Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get current user settings. type="profile" returns user profile info (name, email, company, position, bio). type="notifications" returns notification preferences (email toggles, frequency, thresholds). type="subscription" returns the plan details, usage limits, and usage stats of the brand the call works on, under its owner's plan. Parameters: - `type` (string, required, one of: profile, notifications, subscription): Type of settings to retrieve. "profile" returns user profile info (name, email, company, etc.). "notifications" returns notification preferences (email toggles, frequency, thresholds). "subscription" returns current plan details and usage limits. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_user_settings Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Update current user settings. action="update_profile" updates profile fields (firstName, lastName, phone, company, position, bio, website, country). action="update_notifications" updates notification preferences (email toggles, frequency, sentiment threshold). Parameters: - `action` (string, required, one of: update_profile, update_notifications): Action to perform. "update_profile" updates profile fields. "update_notifications" updates notification preferences. - `firstName` (string, optional): First name (action: update_profile) - `lastName` (string, optional): Last name (action: update_profile) - `phone` (string, optional): Phone number (action: update_profile) - `company` (string, optional): Company name (action: update_profile) - `position` (string, optional): Job title/position (action: update_profile) - `bio` (string, optional): Short bio, max 500 chars (action: update_profile) - `website` (string, optional): Personal/company website URL (action: update_profile) - `country` (string, optional): Country of residence (action: update_profile) - `emailNotifications` (boolean, optional): Master email toggle (action: update_notifications) - `mentionAlerts` (boolean, optional): Alert on new mentions (action: update_notifications) - `sentimentAlerts` (boolean, optional): Alert on sentiment changes (action: update_notifications) - `dailyReports` (boolean, optional): Daily report emails (action: update_notifications) - `weeklyDigest` (boolean, optional): Weekly digest emails (action: update_notifications) - `securityAlerts` (boolean, optional): Security-related alerts (action: update_notifications) - `marketingEmails` (boolean, optional): Marketing/promotional content (action: update_notifications) - `interestedReplyAlerts` (boolean, optional): Alerts when interested leads reply (action: update_notifications) - `productUpdates` (boolean, optional): Product update notifications (action: update_notifications) - `crisisAlerts` (boolean, optional): Crisis/emergency alerts (action: update_notifications) - `campaignNotifications` (boolean, optional): Campaign notification emails -- daily summary, errors, completions (action: update_notifications) - `signalNotifications` (boolean, optional): Signal engine notification emails -- source completed, messages ready to review, campaign launched (action: update_notifications) - `emailFrequency` (string, optional, one of: hourly, daily, weekly): Email delivery frequency (action: update_notifications) - `sentimentThreshold` (string, optional, one of: all, negative, critical): Sentiment filtering level (action: update_notifications) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_brand_settings Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Get settings and configuration for the current brand. Returns brand info, platform toggles, monitored keywords, alerts, or social accounts based on type. Do NOT use for the basic brand list (use brandjet_list_brands). Do NOT use to change settings (use brandjet_manage_brand_settings). Parameters: - `type` (string, required, one of: overview, platforms, keywords, alerts, social_accounts): Type of brand settings to retrieve. "overview" returns full brand config (name, description, website, logo, industry, monitoring status). "platforms" returns platform monitoring toggles. "keywords" returns monitored keywords. "alerts" returns alert settings (thresholds, crisis keywords, notification channels). "social_accounts" returns connected social account handles. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_brand_settings Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Update settings for the current brand. action="update_info" updates brand name, description, website, industry, business type, target audience. action="update_platforms" toggles platform monitoring. action="update_alerts" updates alert thresholds and channels. action="update_social_accounts" updates social handles. action="toggle_monitoring" toggles monitoring on/off. Monitored keywords are read only here and must be changed in Manage Keywords. Parameters: - `action` (string, required, one of: update_info, update_platforms, update_alerts, update_social_accounts, toggle_monitoring): Action to perform. "update_info" updates basic brand info. "update_platforms" toggles platform monitoring. "update_alerts" updates alert thresholds and channels. "update_social_accounts" updates social media handles. "toggle_monitoring" toggles brand monitoring on/off. - `name` (string, optional): Brand name (action: update_info) - `description` (string, optional): Brand description (action: update_info) - `website` (string, optional): Brand website URL (action: update_info) - `industry` (string, optional): Industry category (action: update_info) - `businessType` (string, optional): Business type, e.g. SaaS (action: update_info) - `targetAudience` (string[], optional): Array of audience segments (action: update_info) - `twitter` (boolean, optional): Toggle Twitter/X monitoring (action: update_platforms) - `reddit` (boolean, optional): Toggle Reddit monitoring (action: update_platforms) - `news` (boolean, optional): Toggle News monitoring (action: update_platforms) - `youtube` (boolean, optional): Toggle YouTube monitoring (action: update_platforms) - `linkedin` (boolean, optional): Toggle LinkedIn monitoring (action: update_platforms) - `tiktok` (boolean, optional): Toggle TikTok monitoring (action: update_platforms) - `llm` (boolean, optional): Toggle LLM/AI model monitoring (action: update_platforms) - `sentimentThresholdValue` (number, optional): Sentiment threshold from -1.0 to 1.0 (action: update_alerts) - `volumeThreshold` (number, optional): Volume threshold - mentions per hour (action: update_alerts) - `crisisKeywords` (string[], optional): Keywords that trigger crisis alerts (action: update_alerts) - `emailAlerts` (boolean, optional): Enable email alerts (action: update_alerts) - `slackAlerts` (boolean, optional): Enable Slack alerts (action: update_alerts) - `webhookUrl` (string, optional): Webhook URL for custom notifications (action: update_alerts) - `socialTwitter` (string, optional): Twitter handle without @ (action: update_social_accounts) - `socialLinkedin` (string, optional): LinkedIn company URL (action: update_social_accounts) - `socialFacebook` (string, optional): Facebook page URL (action: update_social_accounts) - `socialInstagram` (string, optional): Instagram handle without @ (action: update_social_accounts) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_brand_members Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage team members for the current brand. action="list" lists all members. action="invite" invites by email with a role. action="change_role" changes a member's role. action="remove" removes a member. action="list_invitations" lists pending invitations. action="cancel_invitation" cancels an invitation. Parameters: - `action` (string, required, one of: list, invite, change_role, remove, list_invitations, cancel_invitation): Action to perform. "list" lists all team members. "invite" invites a new member by email. "change_role" changes a member's role. "remove" removes a team member. "list_invitations" lists pending invitations. "cancel_invitation" cancels a pending invitation. - `email` (string, optional): Email of the person to invite (action: invite) - `role` (string, optional, one of: admin, viewer): Role to assign: "admin" or "viewer" (action: invite, change_role) - `memberId` (string, optional): Member ID (action: change_role, remove) - `invitationId` (string, optional): Invitation ID (action: cancel_invitation) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_team_members Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false List team members (userId, name, email, role, joinedAt) for the current brand. Use this to resolve user IDs returned by other tools — specifically Campaign.ownerId, Conversation.assignedToUserId, and Lead.assignedTo — into readable names and emails. Read-only; use brandjet_manage_brand_members to invite, change roles, or remove members. Parameters: - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_email_warmup Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Manage email warmup to build sender reputation. Warmup gradually increases sending volume by exchanging emails with other warmup accounts. Actions: enable warmup (action="enable"), pause warmup (action="disable", keeps history and ramp progress so enabling again resumes where it left off), bulk enable (action="bulk_enable"), bulk pause (action="bulk_disable"). Do NOT use for email account settings like sending limits or signatures (use brandjet_manage_email_accounts instead). Parameters: - `action` (string, required, one of: enable, disable, bulk_enable, bulk_disable): Action to perform. "enable" enables warmup for a single account and resumes its previous ramp progress if it was paused. "disable" pauses warmup for a single account and keeps its history and ramp progress. "bulk_enable" enables warmup for multiple accounts. "bulk_disable" pauses warmup for multiple accounts. - `accountId` (string, optional): Email account ID (required for enable, disable) - `accountIds` (string[], optional): Email account IDs (required for bulk_enable, bulk_disable) - `maxDailyCount` (integer, optional): Maximum warmup emails per day (default: 40). Used with enable/bulk_enable. - `dailyIncrement` (integer, optional): Number of additional warmup emails added per day during ramp-up (default: 2). Used with enable/bulk_enable. - `startCount` (integer, optional): Number of warmup emails on day 1 (default: 5). Used with enable/bulk_enable. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_search_lead_database Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: true Search BrandJet's lead database for new prospects by job title, seniority, department, location, company, industry, headcount, revenue, funding stage, and technology. Returns 25 people per page with total, totalPages, and hasMore; pages 1 to 3 are free and later pages cost 1 credit per result returned. Each result has id, fullName, jobTitle, seniority, company, companyDomain, industry, location, linkedinUrl, and emailAvailable/phoneAvailable flags; emails and phone numbers are not included. Results are NOT in your lead lists yet and result ids are external lead database ids, not saved BrandJet lead UUIDs. Call brandjet_get_search_filters to see every filter key. Do NOT use to query leads already in your lists (use brandjet_get_leads or brandjet_advanced_filter_leads). Do NOT pass these result ids to brandjet_enrich_leads. To save, export, or bulk reveal contact data from these results, use brandjet_manage_search_results; to reveal one email, use brandjet_find_contact_info with reveal_search_email. Parameters: - `jobTitle` (string[], optional): Current job title or titles, matched as contains (e.g. ["CTO", "Chief Technology Officer"]). Combined with filters.jobTitles. - `company` (string[], optional): Current company name or names. Combined with filters.companyNames. - `industry` (string[], optional): LinkedIn industry name or names (e.g. "Software Development"). Combined with filters.industries. - `country` (string[], optional): Country or countries where the person is based (e.g. "United States"). Combined with filters.personLocations. - `filters` (object, optional): Lead search filters. Strict keys: unknown keys are rejected. A search needs at least one include filter; exclude keys alone are rejected. Locations are real place names ("United States", "California, United States", "Austin, Texas") and technologies are product names ("HubSpot", "Salesforce"). Call brandjet_get_search_filters to see every accepted key with its type, allowed values and examples. - `filters.jobTitles` (string[], optional): Current job title or titles, matched as contains (e.g. ["CTO", "Chief Technology Officer"]). Combined with filters.jobTitles. - `filters.excludeJobTitles` (string[], optional) - `filters.seniorities` (string[], optional) - `filters.departments` (string[], optional) - `filters.personLocations` (string[], optional): Country or countries where the person is based (e.g. "United States"). Combined with filters.personLocations. - `filters.excludePersonLocations` (string[], optional) - `filters.yearsOfExperienceMin` (integer, optional) - `filters.yearsOfExperienceMax` (integer, optional) - `filters.personNames` (string[], optional) - `filters.verifiedEmailOnly` (boolean, optional) - `filters.verifiedMobileOnly` (boolean, optional) - `filters.companyNames` (string[], optional): Current company name or names. Combined with filters.companyNames. - `filters.excludeCompanyNames` (string[], optional) - `filters.companyDomains` (string[], optional) - `filters.excludeCompanyDomains` (string[], optional) - `filters.industries` (string[], optional): LinkedIn industry name or names (e.g. "Software Development"). Combined with filters.industries. - `filters.excludeIndustries` (string[], optional) - `filters.employeeCountMin` (integer, optional) - `filters.employeeCountMax` (integer, optional) - `filters.revenueMin` (string, optional, one of: <100K, 100K, 500K, 1M, 5M, 10M, 25M, 50M, 100M, 250M, 500M, 1B, 5B, 10B+) - `filters.revenueMax` (string, optional, one of: <100K, 100K, 500K, 1M, 5M, 10M, 25M, 50M, 100M, 250M, 500M, 1B, 5B, 10B+) - `filters.fundingStages` (string[], optional) - `filters.technologies` (string[], optional) - `filters.excludeTechnologies` (string[], optional) - `filters.companyLocations` (string[], optional) - `filters.excludeCompanyLocations` (string[], optional) - `filters.foundedMin` (integer, optional) - `filters.foundedMax` (integer, optional) - `filters.companyKeywords` (string[], optional) - `filters.naicsCodes` (integer[], optional) - `filters.sicCodes` (integer[], optional) - `page` (integer, optional): Page number (default: 1). Each page has 25 results. Pages 1 to 3 are free; later pages cost 1 credit per result returned. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_find_contact_info Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: true Find contact information for a specific known person. Costs credits per lookup; a lookup that returns nothing is refunded automatically. "find_email" finds an email by first name, last name, and company domain (2 credits). "linkedin_to_email" finds an email from a LinkedIn profile URL (2 credits). "find_phone" finds a phone number by email or LinkedIn URL (50 credits; check balance first). "reveal_search_email" finds the email of one result from a brandjet_search_lead_database search on this brand in the last 6 hours; pass that result row as person, and only its id is read (2 credits). If the result is no longer available, run the search again. Do NOT use to search for new prospects (use brandjet_search_lead_database). Do NOT use for bulk contact finding (use brandjet_enrich_leads with bulk_find_emails or bulk_find_phones for saved leads, or brandjet_manage_search_results with reveal for search results). Parameters: - `action` (string, required, one of: find_email, linkedin_to_email, find_phone, reveal_search_email): Action to perform. "find_email" finds an email by name + company domain (2 credits). "linkedin_to_email" finds an email from a LinkedIn profile URL (2 credits). "find_phone" finds a phone number by email or LinkedIn URL (50 credits). "reveal_search_email" finds the email of one brandjet_search_lead_database result passed as person (2 credits). Lookups that find nothing are refunded. - `firstName` (string, optional): Person's first name (required for find_email) - `lastName` (string, optional): Person's last name (required for find_email) - `domain` (string, optional): Company domain, e.g. "acme.com" (required for find_email) - `linkedinProfile` (string, optional): LinkedIn profile URL (required for linkedin_to_email, optional for find_phone) - `email` (string, optional): Email address (optional for find_phone) - `person` (object, optional): One result row from a brandjet_search_lead_database search on this brand in the last 6 hours (required for reveal_search_email). Pass the row as returned, or { id }; only the id is read, and the server reads the row from the search that returned it. - `person.id` (string, required): The "id" of the brandjet_search_lead_database result - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_enrich_leads Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: true Enrich existing leads already in your lists with profile data or find contact information in bulk via background jobs. All leadId/leadIds values must be saved BrandJet lead UUIDs. "enrich_lead" enriches a single lead with full profile data via BrandJet's enrichment engine (1 credit). "enrich_list" enriches all leads in a list via a background job (1 credit/lead). "bulk_find_emails" finds emails for multiple saved leads via background job (2 credits per lead where an email is found; misses are refunded; leads that already have an email are skipped and never charged). "bulk_find_phones" finds phone numbers for multiple saved leads via background job (50 credits per lead where a phone is found; misses are refunded - check balance first, the full amount is reserved up front). Do NOT use for single contact lookups (use brandjet_find_contact_info). Do NOT use for external lead database search results (use brandjet_manage_search_results). Parameters: - `action` (string, required, one of: enrich_lead, enrich_list, bulk_find_emails, bulk_find_phones): Action to perform. "enrich_lead" enriches a single lead with full profile data (1 credit). "enrich_list" enriches all leads in a list via background job (1 credit/lead). "bulk_find_emails" finds emails for multiple leads via background job (2 credits/lead; leads that already have an email are skipped). "bulk_find_phones" finds phone numbers for multiple leads via background job (50 credits/lead). Only use this for leads already saved in BrandJet. - `leadId` (string, optional): Lead ID to enrich (required for enrich_lead) - `leadListId` (string, optional): Lead list ID to enrich all leads in (required for enrich_list) - `leadIds` (string[], optional): Array of saved BrandJet lead UUIDs for bulk operations (required for bulk_find_emails, bulk_find_phones). Do not pass external ids from brandjet_search_lead_database. - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_search_results Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: false Import, export, or bulk reveal lead database search results returned by brandjet_search_lead_database. "import" saves the search results named in resultIds to a lead list (free). "export" exports search results with optional email/phone lookups as a background job (1 credit/lead base, +2 with emails, +50 with phones); scope "all" exports every result matching filters (up to 25,000), "current_page" and "selected" export the results named in resultIds. "reveal" finds emails and/or phones for the search results passed as people in one background job (2 credits per email, 50 per phone; unused credits are refunded when the job completes). Import, export and reveal read only each result's id, passed as the id or as the row returned: the server reads each row from the search that returned it, for 6 hours and only on the brand that ran it. If an id is no longer available, run the search again. Export destinations: CSV download, lead list, or campaign. Track jobs with brandjet_get_enrichment_jobs. Use this instead of brandjet_enrich_leads when the rows came from lead database search results. Parameters: - `action` (string, required, one of: import, export, reveal): Action to perform. "import" saves the search results named in resultIds to a lead list (free). "export" exports search results with optional email/phone lookups as a background job (1 credit/lead base, +2 with emails, +50 with phones). "reveal" finds emails and/or phones for the search results passed as people in one background job (2 credits per email, 50 per phone). Use this for results returned by brandjet_search_lead_database. - `resultIds` (string | object[], optional): The brandjet_search_lead_database results to save (required for import) or to export with scope "current_page" or "selected", up to 500. Pass each result's "id", or the result rows as returned; only the id is read, and the server reads each row from the search that returned it. Ids stay valid for 6 hours, and only for the brand that ran the search; after that, run the search again. - `resultIds[].id` (string, required): The "id" of the brandjet_search_lead_database result - `people` (object[], optional): Result rows from a brandjet_search_lead_database search on this brand in the last 6 hours to reveal (required for reveal, up to 500). Pass each row as returned, or { id }; only the id is read, and the server reads each row from the search that returned it. These ids are not saved BrandJet lead UUIDs. - `people[].id` (string, required): The "id" of the brandjet_search_lead_database result - `fields` (string[], optional, one of: email, phone): Fields to reveal for people. Use ["email"], ["phone"], or both. - `listId` (string, optional): Existing lead list ID to import/export into - `newListName` (string, optional): Name for a new lead list to create for import/export - `scope` (string, optional, one of: all, current_page, selected): Export scope (required for export). "all" exports every result matching filters; "current_page" and "selected" export the results named in resultIds. - `filters` (object, optional): Search filters to export with scope "all", in the same format as brandjet_search_lead_database filters. Strict keys: unknown keys are rejected. Call brandjet_get_search_filters to see every accepted key with its type, allowed values and examples. - `filters.jobTitles` (string[], optional) - `filters.excludeJobTitles` (string[], optional) - `filters.seniorities` (string[], optional) - `filters.departments` (string[], optional) - `filters.personLocations` (string[], optional) - `filters.excludePersonLocations` (string[], optional) - `filters.yearsOfExperienceMin` (integer, optional) - `filters.yearsOfExperienceMax` (integer, optional) - `filters.personNames` (string[], optional) - `filters.verifiedEmailOnly` (boolean, optional) - `filters.verifiedMobileOnly` (boolean, optional) - `filters.companyNames` (string[], optional) - `filters.excludeCompanyNames` (string[], optional) - `filters.companyDomains` (string[], optional) - `filters.excludeCompanyDomains` (string[], optional) - `filters.industries` (string[], optional) - `filters.excludeIndustries` (string[], optional) - `filters.employeeCountMin` (integer, optional) - `filters.employeeCountMax` (integer, optional) - `filters.revenueMin` (string, optional, one of: <100K, 100K, 500K, 1M, 5M, 10M, 25M, 50M, 100M, 250M, 500M, 1B, 5B, 10B+) - `filters.revenueMax` (string, optional, one of: <100K, 100K, 500K, 1M, 5M, 10M, 25M, 50M, 100M, 250M, 500M, 1B, 5B, 10B+) - `filters.fundingStages` (string[], optional) - `filters.technologies` (string[], optional) - `filters.excludeTechnologies` (string[], optional) - `filters.companyLocations` (string[], optional) - `filters.excludeCompanyLocations` (string[], optional) - `filters.foundedMin` (integer, optional) - `filters.foundedMax` (integer, optional) - `filters.companyKeywords` (string[], optional) - `filters.naicsCodes` (integer[], optional) - `filters.sicCodes` (integer[], optional) - `maxRows` (integer, optional): Maximum rows to export with scope "all" (default: all matching results, capped at 25,000). Credits are reserved upfront for the estimated row count and unused credits are refunded when the job completes. - `includeEmails` (boolean, optional): Add email addresses to exported leads (+2 credits/lead) - `includePhones` (boolean, optional): Add phone numbers to exported leads (+50 credits/lead) - `destination` (string, optional, one of: csv, list, campaign): Export destination (required for export) - `campaignId` (string, optional): Existing campaign ID when destination is "campaign" - `newCampaignName` (string, optional): Name for a new campaign when destination is "campaign" - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_search_filters Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Return the full catalog of filter keys accepted in the filters object of brandjet_search_lead_database, brandjet_manage_search_results (export), and brandjet_manage_saved_searches. Use this BEFORE building a lead database search. Grouped by section (person, location, company, industry, technology, funding). Each entry includes the key name, type, allowed values or examples, and notes. Pass groupId to narrow the response to a single section. Parameters: - `groupId` (string, optional): Optional group id to return only filters in that group ("person", "location", "company", "industry", "technology", "funding"). - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_enrichment_credits Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Check enrichment credit balance, view purchasable credit tiers, or view credit usage history. Credit costs: person enrichment (1), email finder (2), LinkedIn-to-email (2), phone finder (50), search lead export (1). Lookups that find nothing are refunded, so only successful reveals cost credits. Always check balance before suggesting expensive operations. Parameters: - `action` (string, required, one of: balance, tiers, history): Action to perform. "balance" returns current credit balance. "tiers" lists purchasable credit packs with pricing. "history" returns paginated credit usage history. - `page` (integer, optional): Page number for history (default: 1) - `limit` (integer, optional): Items per page for history (default: 25) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_enrichment_jobs Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false View enrichment background jobs and their progress. "list" shows all jobs for the brand. "get" shows details for a specific job including progress (processed/total items, credits used). "lead_history" shows all enrichment operations performed on a specific lead. Parameters: - `action` (string, required, one of: list, get, lead_history): Action to perform. "list" returns all enrichment jobs for the brand. "get" returns a specific job with progress details. "lead_history" returns enrichment history for a specific lead. - `jobId` (string, optional): Enrichment job ID (required for get) - `leadId` (string, optional): Lead ID to get enrichment history for (required for lead_history) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_manage_saved_searches Annotations: readOnlyHint: false, destructiveHint: false, idempotentHint: false, openWorldHint: false Manage saved lead database searches. Save frequently used search filters for quick reuse. Each saved search has a name and filters in the same format as brandjet_search_lead_database filters. Parameters: - `action` (string, required, one of: list, create, update, delete): Action to perform. "list" returns all saved searches. "create" saves a new search configuration. "update" modifies a saved search. "delete" removes a saved search. - `savedSearchId` (string, optional): Saved search ID (required for update, delete) - `name` (string, optional): Name for the saved search (required for create, optional for update) - `filters` (object, optional): Search filters to save, in the same format as brandjet_search_lead_database filters (required for create, optional for update). Strict keys: unknown keys are rejected. - `filters.jobTitles` (string[], optional) - `filters.excludeJobTitles` (string[], optional) - `filters.seniorities` (string[], optional) - `filters.departments` (string[], optional) - `filters.personLocations` (string[], optional) - `filters.excludePersonLocations` (string[], optional) - `filters.yearsOfExperienceMin` (integer, optional) - `filters.yearsOfExperienceMax` (integer, optional) - `filters.personNames` (string[], optional) - `filters.verifiedEmailOnly` (boolean, optional) - `filters.verifiedMobileOnly` (boolean, optional) - `filters.companyNames` (string[], optional) - `filters.excludeCompanyNames` (string[], optional) - `filters.companyDomains` (string[], optional) - `filters.excludeCompanyDomains` (string[], optional) - `filters.industries` (string[], optional) - `filters.excludeIndustries` (string[], optional) - `filters.employeeCountMin` (integer, optional) - `filters.employeeCountMax` (integer, optional) - `filters.revenueMin` (string, optional, one of: <100K, 100K, 500K, 1M, 5M, 10M, 25M, 50M, 100M, 250M, 500M, 1B, 5B, 10B+) - `filters.revenueMax` (string, optional, one of: <100K, 100K, 500K, 1M, 5M, 10M, 25M, 50M, 100M, 250M, 500M, 1B, 5B, 10B+) - `filters.fundingStages` (string[], optional) - `filters.technologies` (string[], optional) - `filters.excludeTechnologies` (string[], optional) - `filters.companyLocations` (string[], optional) - `filters.excludeCompanyLocations` (string[], optional) - `filters.foundedMin` (integer, optional) - `filters.foundedMax` (integer, optional) - `filters.companyKeywords` (string[], optional) - `filters.naicsCodes` (integer[], optional) - `filters.sicCodes` (integer[], optional) - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_find_ui_element Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Find a specific UI element on the current page. Given a natural language query and the list of available UI elements, identify the best matching element and return its ID. Use this when the user asks "where is X?", "find the X button", "show me how to X", or any request to locate something on the interface. Parameters: - `query` (string, required): Natural language query describing the UI element the user is looking for, e.g. "create campaign button", "inbox", "settings page" - `availableElements` (object[], required): List of UI elements currently visible on the page - `availableElements[].id` (string, required): The data-artemis-id of the element - `availableElements[].label` (string, required): Human-readable label of the element - `availableElements[].description` (string, optional): Optional description of the element - `brandId` (string, optional): Brand id for this call only (see brandjet_list_brands). Defaults to the session brand. ### brandjet_get_tool_run Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false Collect the result of a long tool call. A call that is still working after 45 seconds answers with status "running" and a runId instead of its result, and keeps working in the background. Call this tool with that runId about every 15 seconds. It answers with one of three statuses. "running": the call is still working, so ask again later. "completed": the call has finished, and the rest of this answer is exactly what that call returned, including an error if it failed. "not_found": this login and brand have no run with that runId, because it never existed, finished more than 24 hours ago, or was cut off by a server restart; only then make the original call again. Don't repeat the original call while it runs: an identical call answers with the same runId. Parameters: - `runId` (string, required): The runId from a call that answered with status "running". - `brandId` (string, optional): The brandId you passed on that call, if you passed one. Leave it out otherwise.