Talk to your live-events CRM (campaigns, analytics, paid ads, segments) in Claude and ChatGPT.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Discover available analytics tables and their summary metadata. Call this before nevent_analytics_query, then use nevent_analytics_table_schema to learn valid field names for a selected table.
This tool takes no arguments.
Discover available analytics tables and their summary metadata. Call this before nevent_analytics_query, then use nevent_analytics_table_schema to learn valid field names for a selected table.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Get distinct values available for a field in an analytics table. Useful for building valid filter values before querying.
| Argument | Type | Description |
|---|---|---|
| filters* | array | Fields to get distinct values for |
| collection* | string | Collection name to get filter values for |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"collection",
"filters"
],
"properties": {
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field"
],
"properties": {
"field": {
"type": "string",
"description": "Field name to get distinct values for"
},
"value": {
"description": "Optional seed value"
},
"operator": {
"type": "string",
"description": "Optional operator to apply when retrieving values"
}
},
"additionalProperties": false
},
"description": "Fields to get distinct values for"
},
"collection": {
"type": "string",
"description": "Collection name to get filter values for"
}
},
"additionalProperties": false
}Query event marketing analytics. Supports dimensions, metrics, time ranges, and filters across campaigns, purchases, fans (user_tenants), and more. MANDATORY RULES: (1) ALWAYS call nevent_analytics_table_schema BEFORE querying to discover exact field names. NEVER guess field names. (2) For BOOLEAN fields, use operator "eq" (or "neq") with the boolean value true or false; "is_true"/"is_false" are segmentation operators and analytics rejects them. (3) For enum fields (state, status), check the field description for valid values. Common values: purchases.state = SUCCEEDED|COMPLETE|PENDING|FAILED; campaigns.status = EXECUTED|DRAFT|PAUSED|STOPPED.
| Argument | Type | Description |
|---|---|---|
| ctes | array | CTE (Common Table Expression) sub-queries — v3.19.0+ |
| sort | any | Sort the result rows. Accepts a single { field, order } object or an array for multi-field sorting. |
| limit | number | Maximum rows to return (max 1000, default 100) |
| dryRun | boolean | Dry-run mode: estimate query cost without executing (v3.19.0+). Response includes estimatedBytes in metadata. |
| having | array | HAVING clause filters to apply after aggregation |
| filters | array | WHERE clause filters to apply before aggregation |
| groupBy |
Get the full column schema for a specific analytics table including column names, types, and descriptions.
| Argument | Type | Description |
|---|---|---|
| table* | string | Table name to inspect, e.g. "purchases", "tickets" |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"table"
],
"properties": {
"table": {
"type": "string",
"description": "Table name to inspect, e.g. \"purchases\", \"tickets\""
}
},
"additionalProperties": false
}Generate the monthly campaign report of the current brand for a calendar month (year + month). Executes 13 parallel queries in one call: marketing campaign metrics for that month and the previous one, ROI and attribution, revenue, variable costs, 24-month purchase history, transactional campaigns, segments and industry benchmarks. For a single campaign use nevent_get_campaign_insights.
| Argument | Type | Description |
|---|---|---|
| year* | integer | Calendar year of the monthly report, e.g. 2026 |
| month* | integer | Calendar month of the report, 1 (January) to 12 (December) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"year",
"month"
],
"properties": {
"year": {
"type": "integer",
"maximum": 2100,
"minimum": 2000,
"description": "Calendar year of the monthly report, e.g. 2026"
},
"month": {
"type": "integer",
"maximum": 12,
"minimum": 1,
"description": "Calendar month of the report, 1 (January) to 12 (December)"
}
},
"additionalProperties": false
}Clone an existing email template to create a duplicate as a starting point for a new campaign. Use after nevent_list_templates to pick a template to duplicate. Returns the new cloned template (id, name with "(Copy)" suffix, format, tags). Typically follow with nevent_rename_template and nevent_update_template to customize the clone.
| Argument | Type | Description |
|---|---|---|
| template_id* | string | The ID of the email template to clone. Use nevent_list_templates to discover valid template IDs. The clone will have a new unique ID and its name will be suffixed with "(Copy)". |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id"
],
"properties": {
"template_id": {
"type": "string",
"minLength": 1,
"description": "The ID of the email template to clone. Use nevent_list_templates to discover valid template IDs. The clone will have a new unique ID and its name will be suffixed with \"(Copy)\"."
}
},
"additionalProperties": false
}Generate per-user short URL variants for an existing parent short URL. Each user receives their own unique short link that resolves to the same destination as the parent, but identifies the user on click — used for fan-level click attribution in email/SMS campaigns. The parent short URL must already exist (create it first with nevent_create_short_url). Requires: parentShortCode (from nevent_list_short_urls) and userIds (list of user IDs). Returns: parentShortCode, totalRequested, totalCreated, createdLinks (array of ShortUrlDTO with userId, shortCode, shortUrl per user). Use nevent_get_short_url_campaign_metrics afterwards to track aggregate CTR. WRITE operation — requires STANDARD or FULL operation mode. In READ_ONLY mode this tool returns an operation_not_permitted error immediately without making any API call. Note: parentShortCode is sent in both the URL path and request body — they must match (validated server-side).
| Argument | Type | Description |
|---|---|---|
| userIds* | array | List of user IDs (MongoDB ObjectIds or Nevent user identifiers) to create individual tracking links for. Each user gets a unique short code that resolves to the same destination as the parent. Duplicates are skipped. |
| parentShortCode* | string | Short code of the parent (campaign) short URL (6-8 alphanumeric characters) under which user links will be created. Must already exist. Obtain from nevent_list_short_urls where isParent=true. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"parentShortCode",
"userIds"
],
"properties": {
"userIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"description": "List of user IDs (MongoDB ObjectIds or Nevent user identifiers) to create individual tracking links for. Each user gets a unique short code that resolves to the same destination as the parent. Duplicates are skipped."
},
"parentShortCode": {
"type": "string",
"pattern": "^[A-Za-z0-9]{6,8}$",
"description": "Short code of the parent (campaign) short URL (6-8 alphanumeric characters) under which user links will be created. Must already exist. Obtain from nevent_list_short_urls where isParent=true."
}
},
"additionalProperties": false
}Create a new campaign draft (email, SMS, WhatsApp, push, or multi-channel). PREREQUISITES: call nevent_list_segments to get the target segment_id, and nevent_list_templates to get the template_id. The campaign is always created in DRAFT status — no messages are sent. After creation, call nevent_schedule_campaign to schedule delivery. For EMAIL_ONLY (and email multi-channel): email_subject is required. For SMS_ONLY/WHATSAPP_ONLY/PUSH_ONLY and multi-channel involving those: message is required. Optional fields: from_name, preview_text, template_id, segment_ids, utm_source/medium/campaign/content/term/custom_params, reply_to (email address for reply routing — useful when replies should go to a different mailbox than the From address). Always confirm the segment audience count with the user before scheduling.
| Argument | Type | Description |
|---|---|---|
| name* | string | Campaign name (required, max 255 characters) |
| channel* | string | Delivery channel (nev-api CommunicationChannel enum). Use EMAIL_ONLY, SMS_ONLY, WHATSAPP_ONLY, PUSH_ONLY for single-channel; EMAIL_AND_SMS, EMAIL_AND_WHATSAPP, PUSH_AND_SMS, PUSH_AND_WHATSAPP, SMS_AND_WHATSAPP for multi-channel; ALL_CHANNELS or OMNICHANNEL for broad delivery. Legacy values EMAIL/SMS/WHATSAPP are accepted but deprecated. |
| message | string | Message text body (required when channel=SMS or WHATSAPP) |
| reply_to | string | Reply-To email address (optional). Recipients' replies go to this address instead of the From address. Must be a valid email, max 254 chars. Only meaningful for email-bearing channels. |
| utm_term |
Create and persist a new audience segment from a filter definition. SEMANTICS: criteria in the same stanza are OR-combined — a fan matches the stanza if ANY criterion matches. Stanzas are AND-combined — a fan must match EVERY stanza. To require A AND B, put them in separate stanzas; to accept A OR B, put both in the same stanza. PREREQUISITE: call nevent_segmentation_criteria first to discover valid criterion_ids and operators. MANDATORY RULES: (1) ENTITY operators (is/is_not) accept a single string OR an array of strings — e.g. value: "EVENT_ID" or value: ["E1","E2"]. (2) Omit modifiers unless the user explicitly requests frequency/recency filtering; if included, time_range.value MUST be > 0. (3) Criteria fields: only criterion_id, operator, value — omit id, timeframe, type. (4) KNOWN LIMITATION: do NOT mix attendance criteria (attended_event, ticket_type) with spending criteria (total_spent, ticket_spent, cashless_recharge_amount) in the same stanza — put them in separate stanzas. Separate stanzas are AND-combined, so a fan must match both. After creation, call nevent_segment_preview to count the audience, then nevent_create_campaign to send to this segment.
| Argument | Type | Description |
|---|---|---|
| name* | string | Human-readable name for the segment, e.g. "VIP Attendees 2025" |
| definition* | object | Segment DSL. Criteria in the same stanza are OR-combined: a fan matches the stanza if ANY criterion matches. Stanzas are AND-combined: a fan must match EVERY stanza. To require A AND B, put them in separate stanzas; to accept A OR B, put both in the same stanza. Must have at least one stanza with at least one criterion. Use nevent_segment_preview first to validate the definition. |
| description | string | Optional description of the segment's purpose |
Create a new short URL that redirects to the specified destination. Persists immediately — the short code is active as soon as the call returns. Requires at minimum a valid longUrl. All other fields are optional. Returns the created ShortUrlDTO with: id, shortCode, shortUrl (full redirect URL), longUrl, title, tags, isActive. Use the returned shortCode with nevent_create_bulk_user_short_urls to generate per-user variants. WRITE operation — requires STANDARD or FULL operation mode. In READ_ONLY mode this tool returns an operation_not_permitted error immediately without making any API call.
| Argument | Type | Description |
|---|---|---|
| tags | array | Tags for categorization and filtering. Example: ["campaign", "summer", "2025"]. Use consistent tag names across campaigns. |
| title | string | Descriptive label for the short URL (max 200 chars). Shown in the admin list view and used for search. |
| longUrl* | string | The full destination URL to redirect to. Must include protocol (https:// or http://). Example: "https://nevent.es/events/summer-festival-2025". |
| metadata | object | Arbitrary key-value metadata. Useful for storing campaignId, eventId, or other business identifiers. Example: {"campaignId": "NEV-123", "eventId": "evt-456"}. |
| expiresAt | string | Expiration date/time in ISO 8601 format, e.g. "2025-12-31T23:59:59.000Z". After this date the short URL stops redirecting. Omit for a permanent link. |
| customShortCode |
Create and persist a new email template with MJML or raw HTML content. Prefer MJML for responsive email (set format="MJML"). The template is saved and available for reuse across campaigns. After creation, call nevent_create_campaign with the returned template id to send it to a segment.
| Argument | Type | Description |
|---|---|---|
| name* | string | Human-readable name for the template, e.g. "Event Reminder — Spring 2026" |
| tags | array | List of string tags to categorise the template (e.g. ["promotional", "event", "reminder"]). Omit to create with no tags. |
| format* | string | Template format: "html" for raw HTML, "mjml" for MJML source code |
| html_body | string | Raw HTML content for the template. Provide this field when format is "html". |
| mjml_body | string | MJML source code for the template. Provide this field when format is "mjml". |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"format"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "Human-readable name for the template, e.g. \"Event Reminder — Spring 2026\""
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of string tags to categorise the template (e.g. [\"promotional\", \"event\", \"reminder\"]). Omit to create with no tags."
},
"format": {
"enum": [
"html",
"mjml"
],
"type": "string",
"description": "Template format: \"html\" for raw HTML, \"mjml\" for MJML source code"
},
"html_body": {
"type": "string",
"description": "Raw HTML content for the template. Provide this field when format is \"html\"."
},
"mjml_body": {
"type": "string",
"description": "MJML source code for the template. Provide this field when format is \"mjml\"."
}
},
"additionalProperties": false
}Permanently delete one or more images from the Nevent media library. Provide the CDN URLs (src / destinationUrl) from nevent_list_images or nevent_upload_image. The operation is irreversible. Any email template HTML that references the deleted URLs will show broken images. Requires FULL operation mode (NEVENT_OPERATION_MODE=FULL) and ADMIN, SUPERADMIN, or OWNER role.
| Argument | Type | Description |
|---|---|---|
| urls* | array | Array of CDN image URLs to delete. Use the src/destinationUrl values from nevent_list_images or nevent_upload_image. Minimum 1 URL required. The operation is permanent. Example: ["https://cdn.nevent.es/resources/tenant123/banner.png"]. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"urls"
],
"properties": {
"urls": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"description": "Array of CDN image URLs to delete. Use the src/destinationUrl values from nevent_list_images or nevent_upload_image. Minimum 1 URL required. The operation is permanent. Example: [\"https://cdn.nevent.es/resources/tenant123/banner.png\"]."
}
},
"additionalProperties": false
}Autocomplete values for a segmentation criterion. Useful for discovering valid values when building segment definitions.
| Argument | Type | Description |
|---|---|---|
| search | string | Optional search string to filter matching values |
| criterion_id* | string | Criterion ID from nevent_segmentation_criteria, e.g. "country", "event_attended" |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"criterion_id"
],
"properties": {
"search": {
"type": "string",
"description": "Optional search string to filter matching values"
},
"criterion_id": {
"type": "string",
"description": "Criterion ID from nevent_segmentation_criteria, e.g. \"country\", \"event_attended\""
}
},
"additionalProperties": false
}Retrieve the complete record of a campaign: email subject and body HTML, sending profile, all delivery and engagement metrics (sent, delivered, opens, clicks, unsubscribes, bounces), and tracked links with click counts. Call this after nevent_list_campaigns to drill into a specific campaign. Next step: nevent_get_campaign_insights for AI-generated recommendations, or nevent_campaign_report for a full analytics query.
| Argument | Type | Description |
|---|---|---|
| campaign_id* | string | The campaign Identifier. Use nevent_list_campaigns to discover valid campaign IDs. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"campaign_id"
],
"properties": {
"campaign_id": {
"type": "string",
"description": "The campaign Identifier. Use nevent_list_campaigns to discover valid campaign IDs."
}
},
"additionalProperties": false
}Get pre-computed AI analysis for a specific campaign: performance summary, detected anomalies (e.g. unusually high bounce rate), and improvement recommendations. Call this after nevent_get_campaign when the user asks "how did this campaign perform?" or "what could be improved?". Complements raw metrics from nevent_get_campaign with narrative insights.
| Argument | Type | Description |
|---|---|---|
| campaign_id* | string | The campaign Identifier. Use nevent_list_campaigns to discover valid campaign IDs. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"campaign_id"
],
"properties": {
"campaign_id": {
"type": "string",
"description": "The campaign Identifier. Use nevent_list_campaigns to discover valid campaign IDs."
}
},
"additionalProperties": false
}Get the delivery and engagement counters nev-api holds for one campaign: totalRecipients, totalSent, totalDelivered, totalBounces, totalComplaints, totalOpens, uniqueOpens, totalClicks, uniqueClicks, unsubscribes, the derived rates (openRate, clickRate, clickToOpenRate, bounceRate, unsubscribeRate) and the conversion counters (carts, purchases, revenue). This is the OPERATIONAL source of truth, read straight from nev-api — use it right after a send, and prefer it over nevent_campaign_report when the two disagree, because the report reads the analytics warehouse and lags behind by the data pipeline. Use nevent_campaign_report instead when you need to compare many campaigns, slice by dimension, or join against other analytics. Get campaign_id from nevent_list_campaigns. Follow up with nevent_list_campaign_recipients to see who is behind a number (for example which recipients bounced).
| Argument | Type | Description |
|---|---|---|
| campaign_id* | string | Campaign ID. Get it from nevent_list_campaigns, or from the response of nevent_create_campaign. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"campaign_id"
],
"properties": {
"campaign_id": {
"type": "string",
"minLength": 1,
"description": "Campaign ID. Get it from nevent_list_campaigns, or from the response of nevent_create_campaign."
}
},
"additionalProperties": false
}Get the creative content of a specific ad: copy (body, title, description, CTA), click URL, UTM params, and pre-signed S3 image/video URLs (TTL ~1 hour). Use after nevent_list_paid_ads to get a valid adId. Null imageUrl/videoUrl means the asset mirror job has not run yet — retry in ~5 minutes. For Dynamic Creative Ads (hasDca: true), the dca field contains multiple creative variants. A 404 may mean this tenant is not enrolled in the insights pilot — call nevent_paid_ads_health to confirm.
| Argument | Type | Description |
|---|---|---|
| adId* | string | Ad ID from the provider. Use nevent_list_paid_ads to get valid adId values. |
| provider* | string | Ad provider: meta | google | tiktok |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"provider",
"adId"
],
"properties": {
"adId": {
"type": "string",
"minLength": 1,
"description": "Ad ID from the provider. Use nevent_list_paid_ads to get valid adId values."
},
"provider": {
"enum": [
"meta",
"google",
"tiktok"
],
"type": "string",
"description": "Ad provider: meta | google | tiktok"
}
},
"additionalProperties": false
}Compare an ad group's performance metrics against the mean of its campaign sibling ad groups. Use to detect underperforming ad sets — each metric (costPerResult, CPM, frequency, CTR) is returned with its campaign sibling mean and ratioVsMean (1.0 = on par). For cost metrics (costPerResult, CPM, frequency): ratio > 1.0 means WORSE than siblings (higher cost). For CTR: ratio > 1.0 means BETTER than siblings (higher CTR is better). Use after nevent_list_paid_ad_groups to get a valid adGroupId. A 404 may mean this tenant is not enrolled in the insights pilot — call nevent_paid_ads_health to confirm.
| Argument | Type | Description |
|---|---|---|
| to | any | End date for the comparison window (yyyy-MM-dd). Defaults to today when omitted. |
| from | string | Start date for the comparison window (yyyy-MM-dd). Defaults to 7 days ago when omitted. |
| provider* | string | Ad provider: meta | google | tiktok |
| adGroupId* | string | Ad group (ad set) ID from the provider. Use nevent_list_paid_ad_groups to get valid adGroupId values. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"provider",
"adGroupId"
],
"properties": {
"to": {
"$ref": "#/properties/from",
"description": "End date for the comparison window (yyyy-MM-dd). Defaults to today when omitted."
},
"from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date for the comparison window (yyyy-MM-dd). Defaults to 7 days ago when omitted."
},
"provider": {
"enum": [
"meta",
"google",
"tiktok"
],
"type": "string",
"description": "Ad provider: meta | google | tiktok"
},
"adGroupId": {
"type": "string",
"minLength": 1,
"description": "Ad group (ad set) ID from the provider. Use nevent_list_paid_ad_groups to get valid adGroupId values."
}
},
"additionalProperties": false
}Get daily performance metrics for a specific ad group (ad set). Use after nevent_list_paid_ad_groups to get a valid adGroupId. Date range defaults to the last 7 days when from/to are omitted. Returns daily rows with: spend, impressions, reach, frequency, clicks, CTR, CPM, CPC, ROAS, engagement rate, video metrics. Each row.date is an ISO 8601 UTC timestamp (e.g. "2026-05-10T00:00:00Z"). A 404 may mean this tenant is not enrolled in the insights pilot — call nevent_paid_ads_health to confirm.
| Argument | Type | Description |
|---|---|---|
| to | any | End date for insights window (yyyy-MM-dd). Defaults to today when omitted. |
| from | string | Start date for insights window (yyyy-MM-dd). Defaults to 7 days ago when omitted. |
| provider* | string | Ad provider: meta | google | tiktok |
| adGroupId* | string | Ad group (ad set) ID from the provider. Use nevent_list_paid_ad_groups to get valid adGroupId values. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"provider",
"adGroupId"
],
"properties": {
"to": {
"$ref": "#/properties/from",
"description": "End date for insights window (yyyy-MM-dd). Defaults to today when omitted."
},
"from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date for insights window (yyyy-MM-dd). Defaults to 7 days ago when omitted."
},
"provider": {
"enum": [
"meta",
"google",
"tiktok"
],
"type": "string",
"description": "Ad provider: meta | google | tiktok"
},
"adGroupId": {
"type": "string",
"minLength": 1,
"description": "Ad group (ad set) ID from the provider. Use nevent_list_paid_ad_groups to get valid adGroupId values."
}
},
"additionalProperties": false
}Get the full audience targeting configuration for an ad group. Use after nevent_list_paid_ad_groups to get a valid adGroupId. Returns: ageRange, genders, geoSummary (countries/cities/regions), topInterests, topBehaviors, placements, Advantage+ flags (automaticPlacements, expandAge, expandGender), custom and excluded audiences, bidStrategy, promotedObject. A 404 may mean this tenant is not enrolled in the insights pilot — call nevent_paid_ads_health to confirm.
| Argument | Type | Description |
|---|---|---|
| provider* | string | Ad provider: meta | google | tiktok |
| adGroupId* | string | Ad group (ad set) ID from the provider. Use nevent_list_paid_ad_groups to get valid adGroupId values. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"provider",
"adGroupId"
],
"properties": {
"provider": {
"enum": [
"meta",
"google",
"tiktok"
],
"type": "string",
"description": "Ad provider: meta | google | tiktok"
},
"adGroupId": {
"type": "string",
"minLength": 1,
"description": "Ad group (ad set) ID from the provider. Use nevent_list_paid_ad_groups to get valid adGroupId values."
}
},
"additionalProperties": false
}Get daily performance metrics for a specific paid campaign. Use after nevent_list_paid_campaigns to get a valid campaignId. Date range defaults to the last 7 days when from/to are omitted. Returns daily rows with: spend, impressions, reach, frequency, clicks, CTR, CPM, CPC, ROAS, engagement rate, video metrics. Each row.date is an ISO 8601 UTC timestamp (e.g. "2026-05-10T00:00:00Z"). A 404 may mean this tenant is not enrolled in the insights pilot — call nevent_paid_ads_health to confirm.
| Argument | Type | Description |
|---|---|---|
| to | any | End date for insights window (yyyy-MM-dd). Defaults to today when omitted. |
| from | string | Start date for insights window (yyyy-MM-dd). Defaults to 7 days ago when omitted. |
| provider* | string | Ad provider: meta | google | tiktok |
| campaignId* | string | Paid campaign ID from the provider (not a Nevent ObjectId). Use nevent_list_paid_campaigns to get valid campaignId values. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"provider",
"campaignId"
],
"properties": {
"to": {
"$ref": "#/properties/from",
"description": "End date for insights window (yyyy-MM-dd). Defaults to today when omitted."
},
"from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date for insights window (yyyy-MM-dd). Defaults to 7 days ago when omitted."
},
"provider": {
"enum": [
"meta",
"google",
"tiktok"
],
"type": "string",
"description": "Ad provider: meta | google | tiktok"
},
"campaignId": {
"type": "string",
"minLength": 1,
"description": "Paid campaign ID from the provider (not a Nevent ObjectId). Use nevent_list_paid_campaigns to get valid campaignId values."
}
},
"additionalProperties": false
}Retrieve the complete filter definition of a specific segment (criteria stanzas, operators, values) along with its estimated contact count and metadata. Call this after nevent_list_segments when you need to inspect, clone, or explain a segment's logic. Next step: nevent_segment_preview to count the audience, or nevent_update_segment to modify the definition.
| Argument | Type | Description |
|---|---|---|
| segment_id* | string | Identifier of the segment to retrieve. Get valid IDs from nevent_list_segments. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"segment_id"
],
"properties": {
"segment_id": {
"type": "string",
"pattern": "^[a-f0-9]{24}$",
"minLength": 1,
"description": "Identifier of the segment to retrieve. Get valid IDs from nevent_list_segments."
}
},
"additionalProperties": false
}Call this before creating a campaign to verify the tenant is ready to send email. Returns: sender domain(s) and their validation status, warm-up phase (cold/warming/warmed), daily send rate cap, and throttle settings. If the sending profile is not validated or still in warm-up, warn the user before scheduling a large campaign. Combine with nevent_get_suppressions_summary for a full deliverability health check.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Get complete details of a specific short URL including target URL, metadata, creation date, expiration, tags, and current click count. Use after nevent_list_short_urls to get the `id`. Key fields returned: id, shortCode, shortUrl, longUrl, title, tags, metadata, clickCount, lastClickedAt, isActive, isExpired, isParent, parentShortCode, userId, userLinksCount. Use the returned id with nevent_get_short_url_metrics for time-series analytics.
| Argument | Type | Description |
|---|---|---|
| id* | string | MongoDB ObjectId of the short URL (24 hex characters). Obtain from nevent_list_short_urls response field "id". |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-f0-9]{24}$",
"description": "MongoDB ObjectId of the short URL (24 hex characters). Obtain from nevent_list_short_urls response field \"id\"."
}
},
"additionalProperties": false
}Get aggregated click metrics across a parent short URL and all its per-user variants. Use when a marketing campaign was sent with per-user tracking links (created via nevent_create_bulk_user_short_urls) to see total reach and CTR. Requires the `parentShortCode` from nevent_list_short_urls (where isParent=true). Returns: totalChildUrls, totalClicks, urlsWithClicks, avgClicksPerUrl, clickThroughRate (%), topUsersByClicks (userId, shortCode, clickCount, lastClickedAt), clicksByDay, clicksByDevice, clicksByBrowser, clicksByCountry. This tool aggregates across ALL child user links — use nevent_get_short_url_metrics(id) when you need per-link breakdown for a single URL.
| Argument | Type | Description |
|---|---|---|
| days | integer | Number of days to include in metrics. Default: 30. |
| topN | integer | Number of top-performing users to return in topUsersByClicks. Default: 10. |
| parentShortCode* | string | Short code of the parent (campaign) short URL (6-8 alphanumeric characters). Obtain from nevent_list_short_urls where isParent=true, field "shortCode". |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"parentShortCode"
],
"properties": {
"days": {
"type": "integer",
"maximum": 365,
"minimum": 1,
"description": "Number of days to include in metrics. Default: 30."
},
"topN": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Number of top-performing users to return in topUsersByClicks. Default: 10."
},
"parentShortCode": {
"type": "string",
"pattern": "^[A-Za-z0-9]{6,8}$",
"description": "Short code of the parent (campaign) short URL (6-8 alphanumeric characters). Obtain from nevent_list_short_urls where isParent=true, field \"shortCode\"."
}
},
"additionalProperties": false
}Get individual click event records for a specific short URL, ordered by most recent first. Use after nevent_list_short_urls to get the `id`. Each click record includes: clickedAt, ipAddress, userAgent, referer, country, city, device, browser, os, utmSource, utmCampaign, fbclid, gclid, isPaidTraffic. Use for detailed click attribution, fraud detection, or per-user behavior analysis. Default returns 100 most recent clicks; use limit to adjust.
| Argument | Type | Description |
|---|---|---|
| id* | string | MongoDB ObjectId of the short URL (24 hex characters). Obtain from nevent_list_short_urls response field "id". |
| limit | integer | Maximum number of recent click records to return, ordered newest-first. Default: 100. Max: 1000. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-f0-9]{24}$",
"description": "MongoDB ObjectId of the short URL (24 hex characters). Obtain from nevent_list_short_urls response field \"id\"."
},
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Maximum number of recent click records to return, ordered newest-first. Default: 100. Max: 1000."
}
},
"additionalProperties": false
}Get aggregated click analytics for a specific short URL over a time window (default 30 days). Use after nevent_list_short_urls to get the `id`. Returns: totalClicks, uniqueVisitors, firstClickAt, lastClickAt, clicksByDay (date → count), clicksByCountry, clicksByDevice (mobile/desktop/tablet), clicksByBrowser, clicksByOs, topReferers. Use for performance analysis of individual tracking links. For campaign-wide aggregation across all user links, use nevent_get_short_url_campaign_metrics instead.
| Argument | Type | Description |
|---|---|---|
| id* | string | MongoDB ObjectId of the short URL (24 hex characters). Obtain from nevent_list_short_urls response field "id". |
| days | integer | Number of days to include in metrics calculation. Default: 30. Max: 365. Use 7 for last week, 30 for last month, 90 for last quarter. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-f0-9]{24}$",
"description": "MongoDB ObjectId of the short URL (24 hex characters). Obtain from nevent_list_short_urls response field \"id\"."
},
"days": {
"type": "integer",
"maximum": 365,
"minimum": 1,
"description": "Number of days to include in metrics calculation. Default: 30. Max: 365. Use 7 for last week, 30 for last month, 90 for last quarter."
}
},
"additionalProperties": false
}Get a deliverability health snapshot for the active tenant: total suppressed emails (hard bounces + complaints + manual unsubscribes), 30-day trend, and breakdown by suppression reason. Call this when the user asks about list health, unsubscribe rates, or bounce issues. A suppression rate above 2% indicates deliverability risk — surface this as a warning before scheduling a large campaign.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Retrieve the full content of an email template: MJML source, rendered HTML, tags, and usage metrics (how many campaigns used this template). Call this after nevent_list_templates when the user wants to inspect, copy, or modify a template. Next step: nevent_update_template to change the content, or nevent_create_campaign to use this template in a new campaign.
| Argument | Type | Description |
|---|---|---|
| template_id* | string | The Identifier of the template to retrieve. Get valid IDs from nevent_list_templates. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id"
],
"properties": {
"template_id": {
"type": "string",
"pattern": "^[a-f0-9]{24}$",
"description": "The Identifier of the template to retrieve. Get valid IDs from nevent_list_templates."
}
},
"additionalProperties": false
}Get guidance when you are unsure which tool to call or how to handle an error. Returns structured markdown for the requested topic. Call with topic="workflows" for common patterns, topic="errors" for error code meanings, topic="tenants" for multi-tenant guidance, or topic=<category> like "paid_media" / "analytics" / "segments". Omit topic to get an index of all available topics.
| Argument | Type | Description |
|---|---|---|
| topic | string | Topic to get guidance on. Omit to get an index of all available topics. Values: workflows | errors | tenants | analytics | segments | campaigns | templates | deliverability | paid_media | short_urls | media |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"topic": {
"enum": [
"workflows",
"errors",
"tenants",
"analytics",
"segments",
"campaigns",
"templates",
"deliverability",
"paid_media",
"short_urls",
"media"
],
"type": "string",
"description": "Topic to get guidance on. Omit to get an index of all available topics. Values: workflows | errors | tenants | analytics | segments | campaigns | templates | deliverability | paid_media | short_urls | media"
}
},
"additionalProperties": false
}List the individual recipients of a campaign and what happened to each message. Use this to put names behind the aggregate numbers from nevent_get_campaign_metrics: who bounced, who clicked, who unsubscribed. Filter with status (SCHEDULED, DELIVERED, OPENED, CLICKED, BOUNCES, UNSUBSCRIBES), narrow to one audience with segment_id when the campaign targeted several segments, or find one person with search (matches name and email). Returns a paginated envelope — content (the recipient rows), page, size, totalElements, totalPages. Rows contain personal data: request the smallest page that answers the question, filter rather than paginate through everything, and do not dump full recipient lists into a summary.
| Argument | Type | Description |
|---|---|---|
| page | integer | Zero-based page number. Default: 0 (first page). |
| search | string | Free-text search across recipient name and email address. |
| status | string | Filter recipients by delivery state. SCHEDULED = queued but not sent; DELIVERED = accepted by the receiving server; OPENED / CLICKED = engaged; BOUNCES = delivery failed; UNSUBSCRIBES = opted out from this send. Omit to return every recipient. |
| page_size | integer | Recipients per page (1-100). Default: 25. Keep this small — recipient rows contain personal data and large pages waste context. |
| segment_id | string | Restrict the listing to recipients that came from one segment. Useful on multi-segment campaigns to compare which segment engaged. Get segment IDs from nevent_list_segments. |
Call this to discover existing campaigns before reporting on performance or scheduling new sends. Returns campaigns for the active tenant with status, channel, send date, and top-level engagement metrics (sent, open rate, click rate). Filter by status (DRAFT/SCHEDULED/SENT/FAILED), channel (EMAIL/SMS), or date range. Use the returned campaign id to call nevent_get_campaign (full content + metrics) or nevent_get_campaign_insights (AI analysis).
| Argument | Type | Description |
|---|---|---|
| sort | string | Field to sort by: createdAt (default) | executedAt | name |
| limit | integer | Maximum number of campaigns to return (default 50, max 200) |
| status | string | Filter by campaign status: EXECUTED | DRAFT | PAUSED | STOPPED | SCHEDULED |
| channel | string | Filter by channel: EMAIL | SMS | WHATSAPP |
| date_to | string | Filter campaigns created on or before this date (ISO 8601, e.g. "2024-12-31T23:59:59Z") |
| date_from | string | Filter campaigns created on or after this date (ISO 8601, e.g. "2024-01-01T00:00:00Z") |
| sort_order | string | Sort direction: asc | desc (default desc) |
List all images stored in the Nevent media library for the current tenant. Returns each image's CDN URL (src), file name, MIME type, and size in bytes. Use the src value in <img src="..."> in email template HTML, or pass it to nevent_delete_image to remove it.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}List ad groups (ad sets) for a paid ads provider, optionally filtered by campaign. Use after nevent_list_paid_campaigns to drill down into a campaign's ad sets. Returns ad group IDs, names, statuses, and lastSyncedAt. Use the returned adGroupId values with the ad group insights, targeting, and comparative stats tools.
| Argument | Type | Description |
|---|---|---|
| provider* | string | Ad provider: meta | google | tiktok |
| campaignId | string | Optional: filter ad groups by parent campaign ID. Use nevent_list_paid_campaigns to get valid campaignId values. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"provider"
],
"properties": {
"provider": {
"enum": [
"meta",
"google",
"tiktok"
],
"type": "string",
"description": "Ad provider: meta | google | tiktok"
},
"campaignId": {
"type": "string",
"minLength": 1,
"description": "Optional: filter ad groups by parent campaign ID. Use nevent_list_paid_campaigns to get valid campaignId values."
}
},
"additionalProperties": false
}List individual ads for a paid ads provider, optionally filtered by campaign and/or ad group. Use after nevent_list_paid_campaigns or nevent_list_paid_ad_groups to drill down to ad level. Returns ad IDs, names, statuses, UTM fields (utmSource, utmMedium, utmCampaign, utmContainsMacros), and lastSyncedAt. Use the returned adId values with nevent_get_paid_ad_creative.
| Argument | Type | Description |
|---|---|---|
| provider* | string | Ad provider: meta | google | tiktok |
| adGroupId | string | Optional: filter ads by parent ad group ID. Use nevent_list_paid_ad_groups to get valid adGroupId values. |
| campaignId | string | Optional: filter ads by parent campaign ID. Use nevent_list_paid_campaigns to get valid campaignId values. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"provider"
],
"properties": {
"provider": {
"enum": [
"meta",
"google",
"tiktok"
],
"type": "string",
"description": "Ad provider: meta | google | tiktok"
},
"adGroupId": {
"type": "string",
"minLength": 1,
"description": "Optional: filter ads by parent ad group ID. Use nevent_list_paid_ad_groups to get valid adGroupId values."
},
"campaignId": {
"type": "string",
"minLength": 1,
"description": "Optional: filter ads by parent campaign ID. Use nevent_list_paid_campaigns to get valid campaignId values."
}
},
"additionalProperties": false
}List all paid campaigns synced from a provider (meta, google, or tiktok). Call this to discover campaignId values — you need a campaignId to call insights or ad group tools. Returns campaign IDs, names, statuses, objectives, and budgets. Use the returned campaignId values with nevent_get_paid_campaign_insights and nevent_list_paid_ad_groups.
| Argument | Type | Description |
|---|---|---|
| provider* | string | Ad provider: meta | google | tiktok |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"provider"
],
"properties": {
"provider": {
"enum": [
"meta",
"google",
"tiktok"
],
"type": "string",
"description": "Ad provider: meta | google | tiktok"
}
},
"additionalProperties": false
}Call this FIRST when you need to build or target an audience. Returns all saved segments for the active tenant: id, name, estimated contact count, and last-execution date. Use the returned segment ids to call nevent_get_segment (for the filter definition), nevent_segment_preview (to verify the audience), or nevent_create_campaign (to send a campaign to that segment).
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}List short links grouped by DESTINATION URL — one row per destination instead of one per link. Use this to answer "how much traffic is this landing page getting across all my campaigns?", which nevent_list_short_urls cannot answer because every campaign send creates its own parent link. Campaign parents pointing at the same canonical destination collapse into a single row with aggregated totalClicks, linksCount (how many links form the group) and campaignsCount (how many distinct campaigns used it). Unlike nevent_list_short_urls, this INCLUDES system-managed assistant links (the ones the chatbot pushes), flagged readOnly=true — never try to edit or delete those. Filter with origin: MANUAL (human-created), CAMPAIGN (generated by sends), ASSISTANT (chatbot), or ALL (default). Each row carries canonicalId and members[] (id + shortCode) — pass those ids to nevent_get_short_url or nevent_get_short_url_metrics to drill into a specific link. Pagination is over GROUPS, not documents.
| Argument | Type | Description |
|---|---|---|
| page | integer | Zero-based page number over destination GROUPS. Default: 0 (first page). |
| origin | string | Filter by where the links came from. ALL (default) = every origin; MANUAL = links a human created; CAMPAIGN = links generated by campaign sends; ASSISTANT = system-managed links the chatbot pushed (read-only). |
| search | string | Free-text search across destination URL, title, and short code. E.g. "festival" to find every destination for that event. |
| pageSize | integer | Number of destination groups per page (1-100). Default: 20. |
List all per-user short URL variants created under a parent (campaign) short URL. Use after nevent_create_bulk_user_short_urls to inspect the generated links, or to audit which users have a tracking link for a campaign. Requires the `parentShortCode` from nevent_list_short_urls (where isParent=true). Returns an array of ShortUrlDTO — each with userId, shortCode, shortUrl, clickCount. Use the returned `id` values with nevent_get_short_url_metrics for per-user analytics.
| Argument | Type | Description |
|---|---|---|
| parentShortCode* | string | Short code of the parent (campaign) short URL (6-8 alphanumeric characters). Obtain from nevent_list_short_urls where isParent=true, field "shortCode". |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"parentShortCode"
],
"properties": {
"parentShortCode": {
"type": "string",
"pattern": "^[A-Za-z0-9]{6,8}$",
"description": "Short code of the parent (campaign) short URL (6-8 alphanumeric characters). Obtain from nevent_list_short_urls where isParent=true, field \"shortCode\"."
}
},
"additionalProperties": false
}List all short URLs for the current tenant with their tracking metrics (click count, last clicked). Use to discover existing campaign links or to audit active tracking URLs. Returns items (array of ShortUrlDTO), total, page, pageSize, totalPages. Key fields per item: id (use with nevent_get_short_url_metrics or nevent_get_short_url_clicks), shortCode (use with nevent_get_short_url_campaign_metrics or nevent_list_short_url_user_links), shortUrl, longUrl, title, tags, clickCount, isActive, isParent. Filter by isActive=true for active links only. Use search to filter by title or URL.
| Argument | Type | Description |
|---|---|---|
| page | integer | Zero-based page number for pagination. Default: 0 (first page). |
| search | string | Free-text search across short code, title, and target URL. E.g. "summer" to find links tagged or titled with that word. |
| isActive | boolean | Filter by active status. true = only active links, false = only inactive/expired links. Omit to return both. |
| pageSize | integer | Number of results per page. Default: 20. Max: 200. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"page": {
"type": "integer",
"minimum": 0,
"description": "Zero-based page number for pagination. Default: 0 (first page)."
},
"search": {
"type": "string",
"minLength": 1,
"description": "Free-text search across short code, title, and target URL. E.g. \"summer\" to find links tagged or titled with that word."
},
"isActive": {
"type": "boolean",
"description": "Filter by active status. true = only active links, false = only inactive/expired links. Omit to return both."
},
"pageSize": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Number of results per page. Default: 20. Max: 200."
}
},
"additionalProperties": false
}Call this to discover available email templates before creating a campaign. Returns templates for the active tenant: id, name, tags, and whether they use MJML or HTML. Use the returned template id in nevent_create_campaign. Call nevent_get_template to inspect the full HTML/MJML source of a specific template.
| Argument | Type | Description |
|---|---|---|
| sort | string | Sort field: createdAt | modifiedAt | name (default modifiedAt) |
| tags | array | Filter templates by tags. Only templates that have ALL specified tags are returned. Omit to return templates regardless of tags. |
| limit | integer | Maximum number of templates to return (default 50, max 200) |
| sort_order | string | Sort direction: asc | desc (default desc) |
| content_nature | string | Filter by AI-assigned content nature classification (e.g. "promotional", "transactional", "newsletter", "event_reminder"). Omit to return templates of all natures. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"sort": {
"enum": [
"createdAt",
"modifiedAt",
"name"
],
"type": "string",
"default": "modifiedAt",
"description": "Sort field: createdAt | modifiedAt | name (default modifiedAt)"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter templates by tags. Only templates that have ALL specified tags are returned. Omit to return templates regardless of tags."
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 200,
"minimum": 1,
"description": "Maximum number of templates to return (default 50, max 200)"
},
"sort_order": {
"enum": [
"asc",
"desc"
],
"type": "string",
"default": "desc",
"description": "Sort direction: asc | desc (default desc)"
},
"content_nature": {
"type": "string",
"description": "Filter by AI-assigned content nature classification (e.g. \"promotional\", \"transactional\", \"newsletter\", \"event_reminder\"). Omit to return templates of all natures."
}
},
"additionalProperties": false
}List all Nevent tenants (clients) accessible to the authenticated user. Returns tenant IDs and names for use with nevent_switch_tenant. SUPERADMIN: returns all tenants in the platform. OWNER/ADMIN: returns only your tenant hierarchy subtree (up to 3 levels).
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Get operational health signals for a paid ads provider. Always call this before claiming "no data" to the user — it surfaces throttle state, feature gate enrollment, stale syncs, and tier. Key fields: throttle.isThrottled (API throttled), throttle.nextAttemptAt (next retry), featureGate.isInTenantAllowlist (pilot access), lastSuccessfulSyncAt, lastSuccessfulInsightsAt, backfillEnabled. A 404 here means this tenant is not enrolled in the insights pilot for this provider.
| Argument | Type | Description |
|---|---|---|
| provider* | string | Ad provider: meta | google | tiktok |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"provider"
],
"properties": {
"provider": {
"enum": [
"meta",
"google",
"tiktok"
],
"type": "string",
"description": "Ad provider: meta | google | tiktok"
}
},
"additionalProperties": false
}Check if a paid ads provider account (meta, google, or tiktok) is connected to this tenant and when data was last synced. Call this first before any ads queries to confirm the integration is active. Returns: connected (bool), accountId, accountName, lastSyncAt.
| Argument | Type | Description |
|---|---|---|
| provider* | string | Ad provider: meta | google | tiktok |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"provider"
],
"properties": {
"provider": {
"enum": [
"meta",
"google",
"tiktok"
],
"type": "string",
"description": "Ad provider: meta | google | tiktok"
}
},
"additionalProperties": false
}Get the most business-focused view of paid ads: links campaigns to actual ticket sales and revenue via UTM matching. Returns per-campaign: ticketsSold, revenue, budget, utmCampaigns (matched UTM values), status. Use this when the user asks about ROI, conversion, or revenue from paid ads. Use after nevent_list_paid_campaigns to cross-reference campaign IDs.
| Argument | Type | Description |
|---|---|---|
| provider* | string | Ad provider: meta | google | tiktok |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"provider"
],
"properties": {
"provider": {
"enum": [
"meta",
"google",
"tiktok"
],
"type": "string",
"description": "Ad provider: meta | google | tiktok"
}
},
"additionalProperties": false
}Preview a template with merge tags resolved against a sample user's profile. Returns originalBody (raw {{tags}}) and personalizedBody (tags replaced with user data), plus detectedMergeTags (all unique tags found). Always call before nevent_send_test_template to validate rendering. Provide sample_user_id or sample_user_email to see real personalization; omit both to see raw tags only.
| Argument | Type | Description |
|---|---|---|
| subject | string | Optional subject line to preview with merge-tag resolution. Example: "Hola {{name|title}}, tu resumen semanal". Omit to skip subject personalization. |
| template_id* | string | The ID of the email template to preview. Use nevent_list_templates to discover valid template IDs. |
| sample_user_id | string | Optional MongoDB user ID for merge-tag personalization. When provided, {{name}}, {{email}} and custom fields are resolved from this user's profile. Takes priority over sample_user_email. Omit to return raw merge tags only. |
| sample_user_email | string | Optional user email to look up within the active tenant for merge-tag personalization. Ignored when sample_user_id is also provided. Omit to return raw merge tags only. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id"
],
"properties": {
"subject": {
"type": "string",
"description": "Optional subject line to preview with merge-tag resolution. Example: \"Hola {{name|title}}, tu resumen semanal\". Omit to skip subject personalization."
},
"template_id": {
"type": "string",
"minLength": 1,
"description": "The ID of the email template to preview. Use nevent_list_templates to discover valid template IDs."
},
"sample_user_id": {
"type": "string",
"minLength": 1,
"description": "Optional MongoDB user ID for merge-tag personalization. When provided, {{name}}, {{email}} and custom fields are resolved from this user's profile. Takes priority over sample_user_email. Omit to return raw merge tags only."
},
"sample_user_email": {
"type": "string",
"format": "email",
"description": "Optional user email to look up within the active tenant for merge-tag personalization. Ignored when sample_user_id is also provided. Omit to return raw merge tags only."
}
},
"additionalProperties": false
}Estimate the credit cost and eligible audience of a campaign BEFORE sending it. Read-only pre-flight check against nev-api POST /campaigns/quote — it never debits credits and never sends. Call this after nevent_create_campaign and before nevent_schedule_campaign: scheduling a campaign the tenant cannot afford fails at send time with a 402. Returns cost (credits required), available (credits in the pool), missing (shortfall), recipientCount, affordable (boolean — the gate to check), blocked, unlimited, and an audience block with uniqueAudience, estimatedEligible per channel, eligibleAnyChannel and emailExclusions (no_email / invalid_email / opt_out / unknown). The audience block is null when the estimate could not be computed: any channel mix touching WhatsApp, more than 20 segments, or a data-api timeout — cost and recipientCount are still valid in that case. Use segment_ids from nevent_list_segments; omit them to quote the full addressable audience. Set transactional=true only for genuinely transactional sends (order confirmations, ticket delivery) — it estimates against the TRANSACTIONAL consent mode, which reaches recipients who opted out of marketing.
| Argument | Type | Description |
|---|---|---|
| channel* | string | Delivery channel to quote (nev-api CommunicationChannel enum). Legacy values EMAIL/SMS/WHATSAPP are accepted and mapped to the _ONLY variants. Channel mixes involving WhatsApp return a null audience block. |
| segment_ids | array | Segment IDs to quote (optional, max 20). Omit to quote the full addressable audience for the channel. More than 20 segments makes the backend skip the audience estimate. |
| transactional | boolean | Whether this is a transactional campaign (default false). Transactional uses the TRANSACTIONAL consent mode for the audience estimate, which reaches recipients who have opted out of marketing. |
Rename an email template without modifying its content (lightweight — no re-render triggered). Use after nevent_clone_template to give the clone a proper name, or to reorganize existing templates. Returns the updated template with the new name. Next step: nevent_update_template to change content, or nevent_preview_template to validate rendering.
| Argument | Type | Description |
|---|---|---|
| name* | string | The new name for the template. Must be between 1 and 255 characters. Duplicate names are allowed by the API. |
| template_id* | string | The ID of the email template to rename. Use nevent_list_templates to get valid template IDs. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "The new name for the template. Must be between 1 and 255 characters. Duplicate names are allowed by the API."
},
"template_id": {
"type": "string",
"minLength": 1,
"description": "The ID of the email template to rename. Use nevent_list_templates to get valid template IDs."
}
},
"additionalProperties": false
}Restore the original tenant context set at session start. ALWAYS call this after cross-tenant queries (nevent_switch_tenant) to avoid leaving your SUPERADMIN account pointing to another tenant. For SUPERADMIN users, tenant switches PERSIST in the user record in the database — this tool reverses that. For OWNER/ADMIN/STAFF users, this resets to the session's home tenant. No parameters needed.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Schedule an existing DRAFT campaign for delivery at a specific ISO-8601 datetime. IMPORTANT: this is a DESTRUCTIVE action — the campaign will be queued for sending to real contacts. You MUST set confirmed=true in the call, which requires explicit user consent. Call nevent_get_campaign first to verify the draft content and recipient segment. scheduled_time must be in the future (ISO-8601, e.g. 2025-06-01T10:00:00Z). The campaign transitions from DRAFT to SCHEDULED status on success.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be the literal value true to proceed. Set confirmed=true to confirm you want to schedule this campaign for sending. |
| campaign_id* | string | Campaign ID to schedule (must be in DRAFT status) |
| scheduled_time* | string | ISO 8601 datetime for scheduled send (must be in the future). Example: "2026-05-01T10:00:00Z" or "2026-05-01T10:00:00+02:00" |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"campaign_id",
"scheduled_time",
"confirmed"
],
"properties": {
"confirmed": {
"type": "boolean",
"const": true,
"description": "Must be the literal value true to proceed. Set confirmed=true to confirm you want to schedule this campaign for sending."
},
"campaign_id": {
"type": "string",
"minLength": 1,
"description": "Campaign ID to schedule (must be in DRAFT status)"
},
"scheduled_time": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 datetime for scheduled send (must be in the future). Example: \"2026-05-01T10:00:00Z\" or \"2026-05-01T10:00:00+02:00\""
}
},
"additionalProperties": false
}Execute a segment definition and retrieve matching contacts with pagination. SEMANTICS: criteria in the same stanza are OR-combined — a fan matches the stanza if ANY criterion matches. Stanzas are AND-combined — a fan must match EVERY stanza. To require A AND B, put them in separate stanzas; to accept A OR B, put both in the same stanza.
| Argument | Type | Description |
|---|---|---|
| page | number | Zero-based page index (default 0) |
| page_size | number | Results per page (max 100, default 20) |
| definition* | object | Segment DSL. Criteria in the same stanza are OR-combined: a fan matches the stanza if ANY criterion matches. Stanzas are AND-combined: a fan must match EVERY stanza. To require A AND B, put them in separate stanzas; to accept A OR B, put both in the same stanza. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"definition"
],
"properties": {
"page": {
"type": "number",
"default": 0,
"minimum": 0,
"description": "Zero-based page index (default 0)"
},
"page_size": {
"type": "number",
"default": 20,
"maximum": 100,
"minimum": 1,
"description": "Results per page (max 100, default 20)"
},
"definition": {
"type": "object",
"required": [
"stanzas"
],
"properties": {
"stanzas": {
"type": "array",
"items": {
"type": "object",
"required": [
"criteria"
],
"properties": {
"id": {
"type": "string",
"description": "Optional stable ID for the stanza. If omitted, the MCP client auto-generates one before sending to the API. Provide your own only if you need stable references across requests."
},
"criteria": {
"type": "array",
"items": {
"type": "object",
"required": [
"criterion_id",
"operator"
],
"properties": {
"id": {
"type": "string",
"description": "Optional stable ID for UI/cross-request correlation. If omitted, the MCP client auto-generates one before sending to the API."
},
"value": {
"description": "Value to match. IMPORTANT rules:\n- ENTITY operators (is/is_not): accepts a single string ID OR an array of string IDs (e.g. \"event_123\" or [\"event_1\", \"event_2\"]).\n- NUMBER: must be a number (not string)\n- BOOLEAN operators (is_true/is_false): no value needed, omit this field.\n- DATE \"between\": array of 2 ISO date strings [start, end]"
},
"filters": {
"type": "object",
"description": "Only needed for user_custom_field criterion. Pass { \"property_name\": \"field_name\" } to specify which custom field.",
"additionalProperties": {}
},
"operator": {
"type": "string",
"description": "Comparison operator. Rules by data type:\n- ENTITY: \"is\" and \"is_not\" accept a single string ID OR an array of string IDs (valueType=array per API). \"is_set\", \"is_not_set\" also supported.\n- TEXT: \"eq\", \"neq\", \"contains\", \"starts_with\", \"ends_with\", \"is_set\", \"is_not_set\"\n- NUMBER/CURRENCY: \"eq\", \"neq\", \"gt\", \"gte\", \"lt\", \"lte\", \"is_set\", \"is_not_set\"\n- BOOLEAN: \"is_true\", \"is_false\". NEVER use \"eq\" with \"true\"/\"false\" strings.\n- DATE: \"before\", \"after\", \"between\", \"eq\", \"is_set\", \"is_not_set\""
},
"modifiers": {
"type": "object",
"properties": {
"frequency": {
"type": "object",
"required": [
"count",
"operator"
],
"properties": {
"count": {
"type": "number"
},
"operator": {
"type": "string"
}
},
"additionalProperties": false
},
"time_range": {
"type": "object",
"required": [
"value",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"value": {
"type": "number",
"minimum": 1
}
},
"additionalProperties": false
}
},
"description": "ADVANCED: Usually OMIT this field entirely. Only include when the user explicitly asks for:\n- \"at least X times\" → { frequency: { count: X, operator: \"gte\" } }\n- \"in the last X days\" → { time_range: { value: X, unit: \"days\" } } (value MUST be > 0; unit is one of days, weeks, months, years)\nIf not asked for frequency or recency, DO NOT include modifiers.",
"additionalProperties": false
},
"criterion_id": {
"type": "string",
"description": "Criterion identifier from nevent_segmentation_criteria. Examples: total_spent, attended_event, user_gender, user_age, campaign_opened, nevent_temperature"
}
},
"additionalProperties": false
},
"minItems": 1,
"description": "Criteria in the same stanza are OR-combined: a fan matches the stanza if ANY criterion matches. Stanzas are AND-combined, so a fan must match EVERY stanza."
}
},
"additionalProperties": false
},
"minItems": 1,
"description": "Array of stanzas. Stanzas are AND-combined: a fan must match EVERY stanza. Criteria inside one stanza are OR-combined, so a fan matching ANY of them matches that stanza."
}
},
"description": "Segment DSL. Criteria in the same stanza are OR-combined: a fan matches the stanza if ANY criterion matches. Stanzas are AND-combined: a fan must match EVERY stanza. To require A AND B, put them in separate stanzas; to accept A OR B, put both in the same stanza.",
"additionalProperties": false
}
},
"additionalProperties": false
}Preview estimated audience size for a segment definition without saving it. Returns fan count and sample contacts. SEMANTICS: criteria in the same stanza are OR-combined — a fan matches the stanza if ANY criterion matches. Stanzas are AND-combined — a fan must match EVERY stanza. To require A AND B, put them in separate stanzas; to accept A OR B, put both in the same stanza. MANDATORY RULES: (1) ENTITY operators (is/is_not) accept a single string OR an array of strings (e.g. value: "EVENT_ID" or value: ["EVENT_1","EVENT_2"]). (2) Do NOT include modifiers unless specifically asked for frequency or recency filtering. If included, time_range.value MUST be > 0. KNOWN LIMITATION: Do NOT combine attendance criteria (attended_event, ticket_type) with spending criteria (total_spent, ticket_spent, cashless_recharge_amount) in the SAME stanza. Put them in SEPARATE stanzas. Example — attended EVENT_ID AND spent >= 200, because a fan must match EVERY stanza: { stanzas: [{ criteria: [{ criterion_id: "attended_event", operator: "is", value: "EVENT_ID" }] }, { criteria: [{ criterion_id: "total_spent", operator: "gte", value: 200 }] }] }.
| Argument | Type | Description |
|---|---|---|
| definition* | object | Segment DSL. Criteria in the same stanza are OR-combined: a fan matches the stanza if ANY criterion matches. Stanzas are AND-combined: a fan must match EVERY stanza. To require A AND B, put them in separate stanzas; to accept A OR B, put both in the same stanza. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"definition"
],
"properties": {
"definition": {
"type": "object",
"required": [
"stanzas"
],
"properties": {
"stanzas": {
"type": "array",
"items": {
"type": "object",
"required": [
"criteria"
],
"properties": {
"id": {
"type": "string",
"description": "Optional stable ID for the stanza. If omitted, the MCP client auto-generates one before sending to the API. Provide your own only if you need stable references across requests."
},
"criteria": {
"type": "array",
"items": {
"type": "object",
"required": [
"criterion_id",
"operator"
],
"properties": {
"id": {
"type": "string",
"description": "Optional stable ID for UI/cross-request correlation. If omitted, the MCP client auto-generates one before sending to the API."
},
"value": {
"description": "Value to match. IMPORTANT rules:\n- ENTITY operators (is/is_not): accepts a single string ID OR an array of string IDs (e.g. \"event_123\" or [\"event_1\", \"event_2\"]).\n- NUMBER: must be a number (not string)\n- BOOLEAN operators (is_true/is_false): no value needed, omit this field.\n- DATE \"between\": array of 2 ISO date strings [start, end]"
},
"filters": {
"type": "object",
"description": "Only needed for user_custom_field criterion. Pass { \"property_name\": \"field_name\" } to specify which custom field.",
"additionalProperties": {}
},
"operator": {
"type": "string",
"description": "Comparison operator. Rules by data type:\n- ENTITY: \"is\" and \"is_not\" accept a single string ID OR an array of string IDs (valueType=array per API). \"is_set\", \"is_not_set\" also supported.\n- TEXT: \"eq\", \"neq\", \"contains\", \"starts_with\", \"ends_with\", \"is_set\", \"is_not_set\"\n- NUMBER/CURRENCY: \"eq\", \"neq\", \"gt\", \"gte\", \"lt\", \"lte\", \"is_set\", \"is_not_set\"\n- BOOLEAN: \"is_true\", \"is_false\". NEVER use \"eq\" with \"true\"/\"false\" strings.\n- DATE: \"before\", \"after\", \"between\", \"eq\", \"is_set\", \"is_not_set\""
},
"modifiers": {
"type": "object",
"properties": {
"frequency": {
"type": "object",
"required": [
"count",
"operator"
],
"properties": {
"count": {
"type": "number"
},
"operator": {
"type": "string"
}
},
"additionalProperties": false
},
"time_range": {
"type": "object",
"required": [
"value",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"value": {
"type": "number",
"minimum": 1
}
},
"additionalProperties": false
}
},
"description": "ADVANCED: Usually OMIT this field entirely. Only include when the user explicitly asks for:\n- \"at least X times\" → { frequency: { count: X, operator: \"gte\" } }\n- \"in the last X days\" → { time_range: { value: X, unit: \"days\" } } (value MUST be > 0; unit is one of days, weeks, months, years)\nIf not asked for frequency or recency, DO NOT include modifiers.",
"additionalProperties": false
},
"criterion_id": {
"type": "string",
"description": "Criterion identifier from nevent_segmentation_criteria. Examples: total_spent, attended_event, user_gender, user_age, campaign_opened, nevent_temperature"
}
},
"additionalProperties": false
},
"minItems": 1,
"description": "Criteria in the same stanza are OR-combined: a fan matches the stanza if ANY criterion matches. Stanzas are AND-combined, so a fan must match EVERY stanza."
}
},
"additionalProperties": false
},
"minItems": 1,
"description": "Array of stanzas. Stanzas are AND-combined: a fan must match EVERY stanza. Criteria inside one stanza are OR-combined, so a fan matching ANY of them matches that stanza."
}
},
"description": "Segment DSL. Criteria in the same stanza are OR-combined: a fan matches the stanza if ANY criterion matches. Stanzas are AND-combined: a fan must match EVERY stanza. To require A AND B, put them in separate stanzas; to accept A OR B, put both in the same stanza.",
"additionalProperties": false
}
},
"additionalProperties": false
}List all available audience segmentation criteria including their IDs, operators, and value types.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Send a test email of the template to one or more email addresses via SES. Use after nevent_preview_template validates rendering. Test emails carry test indicators in headers and are sent via AWS SES. This call may take up to 60 seconds due to SES delivery. Returns success status, list of recipients the email was sent to, and any error details.
| Argument | Type | Description |
|---|---|---|
| emails* | array | List of email addresses to send the test email to. Each entry must be a valid email address. Minimum 1, maximum 10 recipients. Example: ["[email protected]", "[email protected]"]. |
| subject | string | Optional subject line for the test email. Omit to use the default subject from the template. |
| parameters | object | Optional custom parameters for merge-tag substitution in the test email. Key-value pairs where keys match merge tag names. Example: {name: "Juan", city: "Madrid"}. When provided, overrides sample user profile data for the corresponding tags. |
| template_id* | string | The ID of the email template to send as a test. Use nevent_list_templates to discover valid template IDs. |
| sample_user_id | string | Optional user ID for merge-tag personalization in the test email. When provided, {{name}}, {{email}} and custom fields are resolved from this user's profile. Takes priority over sample_user_email. |
Switch the active tenant for this session. All subsequent queries (analytics, segments, campaigns, paid media) will use the specified tenant's data. SUPERADMIN: this mutates your user record in the database — the switch PERSISTS. Always call nevent_reset_tenant when cross-tenant work is done to avoid leaving your account pointing at another tenant. OWNER/ADMIN/STAFF: session-scoped only; you can only switch to tenants in your hierarchy subtree (max 3 levels deep). Use nevent_list_tenants to discover available tenant IDs.
| Argument | Type | Description |
|---|---|---|
| tenant_id* | string | The tenant ID to activate for this MCP session. All subsequent analytics, segmentation, campaign, and paid media queries will use this tenant's data. Use nevent_list_tenants to discover available tenant IDs. SUPERADMIN: this mutates your user record in the database; call nevent_reset_tenant when done. OWNER/ADMIN/STAFF: session-scoped only (can only switch to descendants in your tenant hierarchy). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"tenant_id"
],
"properties": {
"tenant_id": {
"type": "string",
"description": "The tenant ID to activate for this MCP session. All subsequent analytics, segmentation, campaign, and paid media queries will use this tenant's data. Use nevent_list_tenants to discover available tenant IDs. SUPERADMIN: this mutates your user record in the database; call nevent_reset_tenant when done. OWNER/ADMIN/STAFF: session-scoped only (can only switch to descendants in your tenant hierarchy)."
}
},
"additionalProperties": false
}Modify an existing segment's name and/or filter definition. Call this after nevent_get_segment to inspect the current definition before changing it. At least one of name or definition must be provided. After update, call nevent_segment_preview to confirm the new audience count before scheduling a campaign.
| Argument | Type | Description |
|---|---|---|
| name | string | New human-readable name for the segment. Omit to leave unchanged. |
| definition | object | Replacement segment DSL. The full definition is replaced when provided. Criteria in the same stanza are OR-combined: a fan matches the stanza if ANY criterion matches. Stanzas are AND-combined: a fan must match EVERY stanza. Omit to leave the existing definition unchanged. |
| segment_id* | string | Identifier of the segment to update. Use nevent_list_segments to get valid segment IDs. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"segment_id"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "New human-readable name for the segment. Omit to leave unchanged."
},
"definition": {
"type": "object",
"required": [
"stanzas"
],
"properties": {
"stanzas": {
"type": "array",
"items": {
"type": "object",
"required": [
"criteria"
],
"properties": {
"id": {
"type": "string",
"description": "Optional stable ID for the stanza. If omitted, the MCP client auto-generates one before sending to the API. Provide your own only if you need stable references across requests."
},
"criteria": {
"type": "array",
"items": {
"type": "object",
"required": [
"criterion_id",
"operator"
],
"properties": {
"id": {
"type": "string",
"description": "Optional stable ID for UI/cross-request correlation. If omitted, the MCP client auto-generates one before sending to the API."
},
"value": {
"description": "Value to match. IMPORTANT rules:\n- ENTITY operators (is/is_not): accepts a single string ID OR an array of string IDs (e.g. \"event_123\" or [\"event_1\", \"event_2\"]).\n- NUMBER: must be a number (not string)\n- BOOLEAN operators (is_true/is_false): no value needed, omit this field.\n- DATE \"between\": array of 2 ISO date strings [start, end]"
},
"filters": {
"type": "object",
"description": "Only needed for user_custom_field criterion. Pass { \"property_name\": \"field_name\" } to specify which custom field.",
"additionalProperties": {}
},
"operator": {
"type": "string",
"description": "Comparison operator. Rules by data type:\n- ENTITY: \"is\" and \"is_not\" accept a single string ID OR an array of string IDs (valueType=array per API). \"is_set\", \"is_not_set\" also supported.\n- TEXT: \"eq\", \"neq\", \"contains\", \"starts_with\", \"ends_with\", \"is_set\", \"is_not_set\"\n- NUMBER/CURRENCY: \"eq\", \"neq\", \"gt\", \"gte\", \"lt\", \"lte\", \"is_set\", \"is_not_set\"\n- BOOLEAN: \"is_true\", \"is_false\". NEVER use \"eq\" with \"true\"/\"false\" strings.\n- DATE: \"before\", \"after\", \"between\", \"eq\", \"is_set\", \"is_not_set\""
},
"modifiers": {
"type": "object",
"properties": {
"frequency": {
"type": "object",
"required": [
"count",
"operator"
],
"properties": {
"count": {
"type": "number"
},
"operator": {
"type": "string"
}
},
"additionalProperties": false
},
"time_range": {
"type": "object",
"required": [
"value",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"value": {
"type": "number",
"minimum": 1
}
},
"additionalProperties": false
}
},
"description": "ADVANCED: Usually OMIT this field entirely. Only include when the user explicitly asks for:\n- \"at least X times\" → { frequency: { count: X, operator: \"gte\" } }\n- \"in the last X days\" → { time_range: { value: X, unit: \"days\" } } (value MUST be > 0; unit is one of days, weeks, months, years)\nIf not asked for frequency or recency, DO NOT include modifiers.",
"additionalProperties": false
},
"criterion_id": {
"type": "string",
"description": "Criterion identifier from nevent_segmentation_criteria. Examples: total_spent, attended_event, user_gender, user_age, campaign_opened, nevent_temperature"
}
},
"additionalProperties": false
},
"minItems": 1,
"description": "Criteria in the same stanza are OR-combined: a fan matches the stanza if ANY criterion matches. Stanzas are AND-combined, so a fan must match EVERY stanza."
}
},
"additionalProperties": false
},
"minItems": 1,
"description": "Array of stanzas. Stanzas are AND-combined: a fan must match EVERY stanza. Criteria inside one stanza are OR-combined, so a fan matching ANY of them matches that stanza."
}
},
"description": "Replacement segment DSL. The full definition is replaced when provided. Criteria in the same stanza are OR-combined: a fan matches the stanza if ANY criterion matches. Stanzas are AND-combined: a fan must match EVERY stanza. Omit to leave the existing definition unchanged.",
"additionalProperties": false
},
"segment_id": {
"type": "string",
"pattern": "^[a-f0-9]{24}$",
"minLength": 1,
"description": "Identifier of the segment to update. Use nevent_list_segments to get valid segment IDs."
}
},
"additionalProperties": false
}Update an existing short URL's configuration. Only provided fields are changed — omitted fields remain unchanged. Changes apply immediately. Use after nevent_list_short_urls to get the `id`. Supported updates: title, expiresAt (pass null to remove expiration), isActive (true/false), tags (replaces existing), metadata (replaces existing), longUrl (changes redirect destination). Returns the updated ShortUrlDTO. WRITE operation — requires STANDARD or FULL operation mode. In READ_ONLY mode this tool returns an operation_not_permitted error immediately without making any API call.
| Argument | Type | Description |
|---|---|---|
| id* | string | MongoDB ObjectId of the short URL (24 hex characters). Obtain from nevent_list_short_urls response field "id". |
| tags | array | New tag list. Replaces (not merges) the existing tags. |
| title | string | New descriptive title (max 200 chars). Replaces the existing title. |
| longUrl | string | New destination URL. Changes where existing links redirect to — takes effect immediately. |
| isActive | boolean | Activate (true) or deactivate (false) the short URL. Deactivated links stop redirecting immediately. |
| metadata | object | New metadata object. Replaces (not merges) the existing metadata. |
Update an existing email template: change the name, MJML/HTML content, or tags. Call nevent_get_template first to inspect the current version before modifying. At least one of name, content, or tags must be provided. Note: updating a template does NOT retroactively change campaigns already sent with it.
| Argument | Type | Description |
|---|---|---|
| name | string | New human-readable name for the template. Omit to leave unchanged. |
| tags | array | Replacement list of tags. The full tag list is replaced when provided. Omit to leave existing tags unchanged. |
| format | string | New template format: "html" or "mjml". Omit to leave unchanged. |
| html_body | string | New raw HTML content for the template. Omit to leave unchanged. |
| mjml_body | string | New MJML source code for the template. Omit to leave unchanged. |
| template_id* | string | Identifier of the template to update. Use nevent_list_templates to get valid template IDs. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "New human-readable name for the template. Omit to leave unchanged."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Replacement list of tags. The full tag list is replaced when provided. Omit to leave existing tags unchanged."
},
"format": {
"enum": [
"html",
"mjml"
],
"type": "string",
"description": "New template format: \"html\" or \"mjml\". Omit to leave unchanged."
},
"html_body": {
"type": "string",
"description": "New raw HTML content for the template. Omit to leave unchanged."
},
"mjml_body": {
"type": "string",
"description": "New MJML source code for the template. Omit to leave unchanged."
},
"template_id": {
"type": "string",
"pattern": "^[a-f0-9]{24}$",
"description": "Identifier of the template to update. Use nevent_list_templates to get valid template IDs."
}
},
"additionalProperties": false
}Upload an image to the Nevent media library and get a CDN URL. Accepts base64-encoded images as a data URL (data:image/png;base64,...) or as raw base64 with an explicit mimeType. Returns a destinationUrl (CloudFront CDN URL) that can be used directly in <img src="..."> inside email template HTML. Maximum decoded size: 5 MB. Upload the image, then reference the returned destinationUrl in nevent_update_template or nevent_create_template HTML content.
| Argument | Type | Description |
|---|---|---|
| source* | string | Base64-encoded image. Two accepted forms: 1. Data URL: "data:image/png;base64,<base64data>" — MIME type parsed from prefix. 2. Raw base64 string — mimeType parameter required. Maximum decoded size: 5 MB. URL sources are not accepted. |
| mimeType | string | MIME type of the image, e.g. "image/png" or "image/jpeg". Required when source is raw base64 (no data URL prefix). Ignored when source is a data URL (MIME type parsed from prefix). Common values: image/png | image/jpeg | image/gif | image/webp | image/svg+xml. |
| imageName | string | Optional file name for the uploaded resource (e.g. "event-banner.png"). When omitted, a name is generated from the upload timestamp. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"source"
],
"properties": {
"source": {
"type": "string",
"minLength": 1,
"description": "Base64-encoded image. Two accepted forms:\n1. Data URL: \"data:image/png;base64,<base64data>\" — MIME type parsed from prefix.\n2. Raw base64 string — mimeType parameter required.\nMaximum decoded size: 5 MB. URL sources are not accepted."
},
"mimeType": {
"type": "string",
"minLength": 1,
"description": "MIME type of the image, e.g. \"image/png\" or \"image/jpeg\". Required when source is raw base64 (no data URL prefix). Ignored when source is a data URL (MIME type parsed from prefix). Common values: image/png | image/jpeg | image/gif | image/webp | image/svg+xml."
},
"imageName": {
"type": "string",
"minLength": 1,
"description": "Optional file name for the uploaded resource (e.g. \"event-banner.png\"). When omitted, a name is generated from the upload timestamp."
}
},
"additionalProperties": false
}| array |
| Calendar-based group-by fields (v3.19.0+). Known values: dayOfWeek | weekOfYear | hourOfDay | minuteOfHour | month | quarter | year |
| metrics | array | Aggregated metrics to compute (SUM, COUNT, etc.) |
| distinct | boolean | Add SELECT DISTINCT to deduplicate result rows (v3.19.0+) |
| timeRange | object | Time range filter with optional granularity for trend analysis |
| collection* | string | Collection name, e.g. "purchases", "tickets", "campaigns" |
| dimensions | array | Fields to group by (SELECT dimensions). Omit for aggregate-only queries. |
| sourceTable | string | CTE name to use as source instead of a raw collection — v3.19.0+ |
| comparePeriods | object | Period-over-period comparison (YoY, MoM, etc.) — v3.19.0+ |
| timeGranularity | string | Time granularity for bucketing (v3.19.0+). Known values: day | week | month | quarter | year | hour | minute | fiscalQuarter | fiscalYear |
| compareDimensions | object | Comparative dimension analysis configuration |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"collection"
],
"properties": {
"ctes": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"collection"
],
"properties": {
"name": {
"type": "string",
"description": "Name used to reference this CTE via the sourceTable field"
},
"sort": {
"$ref": "#/properties/sort",
"description": "Sort order for the CTE"
},
"limit": {
"type": "number",
"maximum": 10000,
"description": "Row limit for the CTE"
},
"filters": {
"type": "array",
"items": {
"$ref": "#/properties/filters/items"
},
"description": "Filters to apply in the CTE"
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/properties/metrics/items"
},
"description": "Metrics to compute in the CTE"
},
"timeRange": {
"$ref": "#/properties/timeRange",
"description": "Time range filter for the CTE"
},
"collection": {
"type": "string",
"description": "Source collection for this CTE"
},
"dimensions": {
"type": "array",
"items": {
"$ref": "#/properties/dimensions/items"
},
"description": "Dimensions to select in the CTE"
}
},
"additionalProperties": false
},
"description": "CTE (Common Table Expression) sub-queries — v3.19.0+"
},
"sort": {
"anyOf": [
{
"type": "object",
"required": [
"field",
"order"
],
"properties": {
"field": {
"type": "string",
"description": "Field to sort by"
},
"order": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction: asc | desc"
}
},
"additionalProperties": false
},
{
"type": "array",
"items": {
"$ref": "#/properties/sort/anyOf/0"
},
"minItems": 1
}
],
"description": "Sort the result rows. Accepts a single { field, order } object or an array for multi-field sorting."
},
"limit": {
"type": "number",
"default": 100,
"maximum": 1000,
"description": "Maximum rows to return (max 1000, default 100)"
},
"dryRun": {
"type": "boolean",
"description": "Dry-run mode: estimate query cost without executing (v3.19.0+). Response includes estimatedBytes in metadata."
},
"having": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operator"
],
"properties": {
"field": {
"type": "string",
"description": "Aggregated field name"
},
"value": {
"description": "HAVING threshold value"
},
"operator": {
"type": "string",
"description": "Comparison operator (e.g. \"gt\", \"gte\")"
}
},
"additionalProperties": false
},
"description": "HAVING clause filters to apply after aggregation"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operator"
],
"properties": {
"field": {
"type": "string",
"description": "Field name to filter on"
},
"value": {
"description": "Filter value; use array for \"in\" / \"not_in\" / \"between\" operators"
},
"operator": {
"type": "string",
"description": "Comparison operator. Valid values depend on the field type (nevent_analytics_capabilities lists them): eq | neq | gt | gte | lt | lte | in | nin | contains | not_contains | starts_with | ends_with | regex | regex_i | before | after | between | in_range | not_in_range | is_empty | is_not_empty | exists. BOOLEAN fields: eq or neq with true/false."
}
},
"additionalProperties": false
},
"description": "WHERE clause filters to apply before aggregation"
},
"groupBy": {
"type": "array",
"items": {
"type": "string"
},
"description": "Calendar-based group-by fields (v3.19.0+). Known values: dayOfWeek | weekOfYear | hourOfDay | minuteOfHour | month | quarter | year"
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operation"
],
"properties": {
"alias": {
"type": "string",
"description": "Alias for the aggregated column in results"
},
"field": {
"type": "string",
"description": "Field name to aggregate"
},
"operation": {
"type": "string",
"description": "Aggregation function. Known values: sum | count | avg | min | max | count_distinct | median | percentile | stddev | variance | date_diff"
}
},
"additionalProperties": false
},
"description": "Aggregated metrics to compute (SUM, COUNT, etc.)"
},
"distinct": {
"type": "boolean",
"description": "Add SELECT DISTINCT to deduplicate result rows (v3.19.0+)"
},
"timeRange": {
"type": "object",
"required": [
"start",
"end"
],
"properties": {
"end": {
"type": "string",
"description": "End date in ISO 8601 format, e.g. \"2024-12-31\""
},
"start": {
"type": "string",
"description": "Start date in ISO 8601 format, e.g. \"2024-01-01\""
},
"granularity": {
"type": "string",
"description": "Time bucket granularity (deprecated: use top-level timeGranularity)"
}
},
"description": "Time range filter with optional granularity for trend analysis",
"additionalProperties": false
},
"collection": {
"type": "string",
"description": "Collection name, e.g. \"purchases\", \"tickets\", \"campaigns\""
},
"dimensions": {
"type": "array",
"items": {
"type": "object",
"required": [
"field"
],
"properties": {
"alias": {
"type": "string",
"description": "Alias for the column in results"
},
"field": {
"type": "string",
"description": "Field name"
}
},
"additionalProperties": false
},
"description": "Fields to group by (SELECT dimensions). Omit for aggregate-only queries."
},
"sourceTable": {
"type": "string",
"description": "CTE name to use as source instead of a raw collection — v3.19.0+"
},
"comparePeriods": {
"type": "object",
"required": [
"active",
"current",
"previous"
],
"properties": {
"active": {
"type": "boolean",
"description": "Enable period-over-period comparison"
},
"current": {
"type": "object",
"required": [
"start",
"end"
],
"properties": {
"end": {
"type": "string",
"description": "ISO 8601 end date, e.g. \"2024-12-31\""
},
"start": {
"type": "string",
"description": "ISO 8601 start date, e.g. \"2024-01-01\""
}
},
"description": "The reference (current) time period",
"additionalProperties": false
},
"previous": {
"type": "object",
"required": [
"start",
"end"
],
"properties": {
"end": {
"$ref": "#/properties/comparePeriods/properties/current/properties/end"
},
"start": {
"$ref": "#/properties/comparePeriods/properties/current/properties/start"
}
},
"description": "The baseline (previous) time period to compare against",
"additionalProperties": false
}
},
"description": "Period-over-period comparison (YoY, MoM, etc.) — v3.19.0+",
"additionalProperties": false
},
"timeGranularity": {
"type": "string",
"description": "Time granularity for bucketing (v3.19.0+). Known values: day | week | month | quarter | year | hour | minute | fiscalQuarter | fiscalYear"
},
"compareDimensions": {
"type": "object",
"required": [
"active",
"dimensions"
],
"properties": {
"active": {
"type": "boolean",
"description": "Enable comparative analysis"
},
"dimensions": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"value",
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Display name for the comparison group"
},
"field": {
"type": "string",
"description": "Dimension field name"
},
"value": {
"type": "string",
"description": "Dimension field value to compare"
}
},
"additionalProperties": false
},
"description": "Dimension values to compare against each other"
}
},
"description": "Comparative dimension analysis configuration",
"additionalProperties": false
}
},
"additionalProperties": false
}| string |
| UTM term parameter — paid search keyword. Max 100 chars. |
| from_name | string | Sender display name (optional, defaults to tenant sender name) |
| email_body | string | HTML body content of the email (optional, can be set later) |
| utm_medium | string | UTM medium parameter (e.g. "email", "sms"). Max 100 chars. Auto-detected from channel if omitted. |
| utm_source | string | UTM source parameter (e.g. "nevent", "newsletter"). Max 100 chars. |
| segment_ids | array | Array of segment IDs to target (optional, can be set later) |
| template_id | string | Template ID to pre-populate campaign content (optional) |
| utm_content | string | UTM content parameter — differentiates links/variants. Max 100 chars. |
| preview_text | string | Inbox preview text (optional, shown in email client summaries) |
| utm_campaign | string | UTM campaign parameter (e.g. "summer-sale-2026"). Max 100 chars. Defaults to slugified campaign name. |
| email_subject | string | Email subject line (required when channel=EMAIL, max 998 chars per RFC 5322) |
| utm_custom_params | object | Custom tracking parameters as key-value pairs appended to tracked links (optional). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"channel"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Campaign name (required, max 255 characters)"
},
"channel": {
"enum": [
"EMAIL_ONLY",
"SMS_ONLY",
"WHATSAPP_ONLY",
"PUSH_ONLY",
"EMAIL_AND_SMS",
"EMAIL_AND_WHATSAPP",
"PUSH_AND_SMS",
"PUSH_AND_WHATSAPP",
"SMS_AND_WHATSAPP",
"ALL_CHANNELS",
"OMNICHANNEL",
"EMAIL",
"SMS",
"WHATSAPP"
],
"type": "string",
"description": "Delivery channel (nev-api CommunicationChannel enum). Use EMAIL_ONLY, SMS_ONLY, WHATSAPP_ONLY, PUSH_ONLY for single-channel; EMAIL_AND_SMS, EMAIL_AND_WHATSAPP, PUSH_AND_SMS, PUSH_AND_WHATSAPP, SMS_AND_WHATSAPP for multi-channel; ALL_CHANNELS or OMNICHANNEL for broad delivery. Legacy values EMAIL/SMS/WHATSAPP are accepted but deprecated."
},
"message": {
"type": "string",
"description": "Message text body (required when channel=SMS or WHATSAPP)"
},
"reply_to": {
"type": "string",
"format": "email",
"maxLength": 254,
"description": "Reply-To email address (optional). Recipients' replies go to this address instead of the From address. Must be a valid email, max 254 chars. Only meaningful for email-bearing channels."
},
"utm_term": {
"type": "string",
"maxLength": 100,
"description": "UTM term parameter — paid search keyword. Max 100 chars."
},
"from_name": {
"type": "string",
"maxLength": 255,
"description": "Sender display name (optional, defaults to tenant sender name)"
},
"email_body": {
"type": "string",
"description": "HTML body content of the email (optional, can be set later)"
},
"utm_medium": {
"type": "string",
"maxLength": 100,
"description": "UTM medium parameter (e.g. \"email\", \"sms\"). Max 100 chars. Auto-detected from channel if omitted."
},
"utm_source": {
"type": "string",
"maxLength": 100,
"description": "UTM source parameter (e.g. \"nevent\", \"newsletter\"). Max 100 chars."
},
"segment_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of segment IDs to target (optional, can be set later)"
},
"template_id": {
"type": "string",
"description": "Template ID to pre-populate campaign content (optional)"
},
"utm_content": {
"type": "string",
"maxLength": 100,
"description": "UTM content parameter — differentiates links/variants. Max 100 chars."
},
"preview_text": {
"type": "string",
"maxLength": 500,
"description": "Inbox preview text (optional, shown in email client summaries)"
},
"utm_campaign": {
"type": "string",
"maxLength": 100,
"description": "UTM campaign parameter (e.g. \"summer-sale-2026\"). Max 100 chars. Defaults to slugified campaign name."
},
"email_subject": {
"type": "string",
"maxLength": 998,
"description": "Email subject line (required when channel=EMAIL, max 998 chars per RFC 5322)"
},
"utm_custom_params": {
"type": "object",
"description": "Custom tracking parameters as key-value pairs appended to tracked links (optional).",
"additionalProperties": {
"type": "string"
}
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"definition"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "Human-readable name for the segment, e.g. \"VIP Attendees 2025\""
},
"definition": {
"type": "object",
"required": [
"stanzas"
],
"properties": {
"stanzas": {
"type": "array",
"items": {
"type": "object",
"required": [
"criteria"
],
"properties": {
"id": {
"type": "string",
"description": "Optional stable ID for the stanza. If omitted, the MCP client auto-generates one before sending to the API. Provide your own only if you need stable references across requests."
},
"criteria": {
"type": "array",
"items": {
"type": "object",
"required": [
"criterion_id",
"operator"
],
"properties": {
"id": {
"type": "string",
"description": "Optional stable ID for UI/cross-request correlation. If omitted, the MCP client auto-generates one before sending to the API."
},
"value": {
"description": "Value to match. IMPORTANT rules:\n- ENTITY operators (is/is_not): accepts a single string ID OR an array of string IDs (e.g. \"event_123\" or [\"event_1\", \"event_2\"]).\n- NUMBER: must be a number (not string)\n- BOOLEAN operators (is_true/is_false): no value needed, omit this field.\n- DATE \"between\": array of 2 ISO date strings [start, end]"
},
"filters": {
"type": "object",
"description": "Only needed for user_custom_field criterion. Pass { \"property_name\": \"field_name\" } to specify which custom field.",
"additionalProperties": {}
},
"operator": {
"type": "string",
"description": "Comparison operator. Rules by data type:\n- ENTITY: \"is\" and \"is_not\" accept a single string ID OR an array of string IDs (valueType=array per API). \"is_set\", \"is_not_set\" also supported.\n- TEXT: \"eq\", \"neq\", \"contains\", \"starts_with\", \"ends_with\", \"is_set\", \"is_not_set\"\n- NUMBER/CURRENCY: \"eq\", \"neq\", \"gt\", \"gte\", \"lt\", \"lte\", \"is_set\", \"is_not_set\"\n- BOOLEAN: \"is_true\", \"is_false\". NEVER use \"eq\" with \"true\"/\"false\" strings.\n- DATE: \"before\", \"after\", \"between\", \"eq\", \"is_set\", \"is_not_set\""
},
"modifiers": {
"type": "object",
"properties": {
"frequency": {
"type": "object",
"required": [
"count",
"operator"
],
"properties": {
"count": {
"type": "number"
},
"operator": {
"type": "string"
}
},
"additionalProperties": false
},
"time_range": {
"type": "object",
"required": [
"value",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"value": {
"type": "number",
"minimum": 1
}
},
"additionalProperties": false
}
},
"description": "ADVANCED: Usually OMIT this field entirely. Only include when the user explicitly asks for:\n- \"at least X times\" → { frequency: { count: X, operator: \"gte\" } }\n- \"in the last X days\" → { time_range: { value: X, unit: \"days\" } } (value MUST be > 0; unit is one of days, weeks, months, years)\nIf not asked for frequency or recency, DO NOT include modifiers.",
"additionalProperties": false
},
"criterion_id": {
"type": "string",
"description": "Criterion identifier from nevent_segmentation_criteria. Examples: total_spent, attended_event, user_gender, user_age, campaign_opened, nevent_temperature"
}
},
"additionalProperties": false
},
"minItems": 1,
"description": "Criteria in the same stanza are OR-combined: a fan matches the stanza if ANY criterion matches. Stanzas are AND-combined, so a fan must match EVERY stanza."
}
},
"additionalProperties": false
},
"minItems": 1,
"description": "Array of stanzas. Stanzas are AND-combined: a fan must match EVERY stanza. Criteria inside one stanza are OR-combined, so a fan matching ANY of them matches that stanza."
}
},
"description": "Segment DSL. Criteria in the same stanza are OR-combined: a fan matches the stanza if ANY criterion matches. Stanzas are AND-combined: a fan must match EVERY stanza. To require A AND B, put them in separate stanzas; to accept A OR B, put both in the same stanza. Must have at least one stanza with at least one criterion. Use nevent_segment_preview first to validate the definition.",
"additionalProperties": false
},
"description": {
"type": "string",
"description": "Optional description of the segment's purpose"
}
},
"additionalProperties": false
}| string |
| Custom short code (6-8 alphanumeric characters). If omitted, a unique code is auto-generated. Example: "SUMMER". Use nevent_validate_short_code (if available) to check availability first. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"longUrl"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"description": "Tags for categorization and filtering. Example: [\"campaign\", \"summer\", \"2025\"]. Use consistent tag names across campaigns."
},
"title": {
"type": "string",
"maxLength": 200,
"description": "Descriptive label for the short URL (max 200 chars). Shown in the admin list view and used for search."
},
"longUrl": {
"type": "string",
"format": "uri",
"description": "The full destination URL to redirect to. Must include protocol (https:// or http://). Example: \"https://nevent.es/events/summer-festival-2025\"."
},
"metadata": {
"type": "object",
"description": "Arbitrary key-value metadata. Useful for storing campaignId, eventId, or other business identifiers. Example: {\"campaignId\": \"NEV-123\", \"eventId\": \"evt-456\"}.",
"additionalProperties": {}
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "Expiration date/time in ISO 8601 format, e.g. \"2025-12-31T23:59:59.000Z\". After this date the short URL stops redirecting. Omit for a permanent link."
},
"customShortCode": {
"type": "string",
"pattern": "^[A-Za-z0-9]+$",
"maxLength": 8,
"minLength": 6,
"description": "Custom short code (6-8 alphanumeric characters). If omitted, a unique code is auto-generated. Example: \"SUMMER\". Use nevent_validate_short_code (if available) to check availability first."
}
},
"additionalProperties": false
}| campaign_id* | string | Campaign ID. Get it from nevent_list_campaigns, or from the response of nevent_create_campaign. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"campaign_id"
],
"properties": {
"page": {
"type": "integer",
"minimum": 0,
"description": "Zero-based page number. Default: 0 (first page)."
},
"search": {
"type": "string",
"description": "Free-text search across recipient name and email address."
},
"status": {
"enum": [
"SCHEDULED",
"DELIVERED",
"OPENED",
"CLICKED",
"BOUNCES",
"UNSUBSCRIBES"
],
"type": "string",
"description": "Filter recipients by delivery state. SCHEDULED = queued but not sent; DELIVERED = accepted by the receiving server; OPENED / CLICKED = engaged; BOUNCES = delivery failed; UNSUBSCRIBES = opted out from this send. Omit to return every recipient."
},
"page_size": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Recipients per page (1-100). Default: 25. Keep this small — recipient rows contain personal data and large pages waste context."
},
"segment_id": {
"type": "string",
"description": "Restrict the listing to recipients that came from one segment. Useful on multi-segment campaigns to compare which segment engaged. Get segment IDs from nevent_list_segments."
},
"campaign_id": {
"type": "string",
"minLength": 1,
"description": "Campaign ID. Get it from nevent_list_campaigns, or from the response of nevent_create_campaign."
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"sort": {
"enum": [
"createdAt",
"executedAt",
"name"
],
"type": "string",
"default": "createdAt",
"description": "Field to sort by: createdAt (default) | executedAt | name"
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 200,
"minimum": 1,
"description": "Maximum number of campaigns to return (default 50, max 200)"
},
"status": {
"enum": [
"EXECUTED",
"DRAFT",
"PAUSED",
"STOPPED",
"SCHEDULED"
],
"type": "string",
"description": "Filter by campaign status: EXECUTED | DRAFT | PAUSED | STOPPED | SCHEDULED"
},
"channel": {
"enum": [
"EMAIL",
"SMS",
"WHATSAPP"
],
"type": "string",
"description": "Filter by channel: EMAIL | SMS | WHATSAPP"
},
"date_to": {
"type": "string",
"format": "date-time",
"description": "Filter campaigns created on or before this date (ISO 8601, e.g. \"2024-12-31T23:59:59Z\")"
},
"date_from": {
"type": "string",
"format": "date-time",
"description": "Filter campaigns created on or after this date (ISO 8601, e.g. \"2024-01-01T00:00:00Z\")"
},
"sort_order": {
"enum": [
"asc",
"desc"
],
"type": "string",
"default": "desc",
"description": "Sort direction: asc | desc (default desc)"
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"page": {
"type": "integer",
"minimum": 0,
"description": "Zero-based page number over destination GROUPS. Default: 0 (first page)."
},
"origin": {
"enum": [
"ALL",
"MANUAL",
"CAMPAIGN",
"ASSISTANT"
],
"type": "string",
"description": "Filter by where the links came from. ALL (default) = every origin; MANUAL = links a human created; CAMPAIGN = links generated by campaign sends; ASSISTANT = system-managed links the chatbot pushed (read-only)."
},
"search": {
"type": "string",
"description": "Free-text search across destination URL, title, and short code. E.g. \"festival\" to find every destination for that event."
},
"pageSize": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Number of destination groups per page (1-100). Default: 20."
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"channel"
],
"properties": {
"channel": {
"enum": [
"EMAIL_ONLY",
"SMS_ONLY",
"WHATSAPP_ONLY",
"PUSH_ONLY",
"EMAIL_AND_SMS",
"EMAIL_AND_WHATSAPP",
"PUSH_AND_SMS",
"PUSH_AND_WHATSAPP",
"SMS_AND_WHATSAPP",
"ALL_CHANNELS",
"OMNICHANNEL",
"EMAIL",
"SMS",
"WHATSAPP"
],
"type": "string",
"description": "Delivery channel to quote (nev-api CommunicationChannel enum). Legacy values EMAIL/SMS/WHATSAPP are accepted and mapped to the _ONLY variants. Channel mixes involving WhatsApp return a null audience block."
},
"segment_ids": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20,
"description": "Segment IDs to quote (optional, max 20). Omit to quote the full addressable audience for the channel. More than 20 segments makes the backend skip the audience estimate."
},
"transactional": {
"type": "boolean",
"description": "Whether this is a transactional campaign (default false). Transactional uses the TRANSACTIONAL consent mode for the audience estimate, which reaches recipients who have opted out of marketing."
}
},
"additionalProperties": false
}| sample_user_email |
| string |
| Optional user email within the active tenant for merge-tag personalization. Ignored when sample_user_id is also provided. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id",
"emails"
],
"properties": {
"emails": {
"type": "array",
"items": {
"type": "string",
"format": "email"
},
"maxItems": 10,
"minItems": 1,
"description": "List of email addresses to send the test email to. Each entry must be a valid email address. Minimum 1, maximum 10 recipients. Example: [\"[email protected]\", \"[email protected]\"]."
},
"subject": {
"type": "string",
"description": "Optional subject line for the test email. Omit to use the default subject from the template."
},
"parameters": {
"type": "object",
"description": "Optional custom parameters for merge-tag substitution in the test email. Key-value pairs where keys match merge tag names. Example: {name: \"Juan\", city: \"Madrid\"}. When provided, overrides sample user profile data for the corresponding tags.",
"additionalProperties": {}
},
"template_id": {
"type": "string",
"minLength": 1,
"description": "The ID of the email template to send as a test. Use nevent_list_templates to discover valid template IDs."
},
"sample_user_id": {
"type": "string",
"minLength": 1,
"description": "Optional user ID for merge-tag personalization in the test email. When provided, {{name}}, {{email}} and custom fields are resolved from this user's profile. Takes priority over sample_user_email."
},
"sample_user_email": {
"type": "string",
"format": "email",
"description": "Optional user email within the active tenant for merge-tag personalization. Ignored when sample_user_id is also provided."
}
},
"additionalProperties": false
}| expiresAt |
| any |
| New expiration date/time (ISO 8601). Pass null to remove an existing expiration and make the link permanent. Omit this field entirely to leave expiration unchanged. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-f0-9]{24}$",
"description": "MongoDB ObjectId of the short URL (24 hex characters). Obtain from nevent_list_short_urls response field \"id\"."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"description": "New tag list. Replaces (not merges) the existing tags."
},
"title": {
"type": "string",
"maxLength": 200,
"description": "New descriptive title (max 200 chars). Replaces the existing title."
},
"longUrl": {
"type": "string",
"format": "uri",
"description": "New destination URL. Changes where existing links redirect to — takes effect immediately."
},
"isActive": {
"type": "boolean",
"description": "Activate (true) or deactivate (false) the short URL. Deactivated links stop redirecting immediately."
},
"metadata": {
"type": "object",
"description": "New metadata object. Replaces (not merges) the existing metadata.",
"additionalProperties": {}
},
"expiresAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"description": "New expiration date/time (ISO 8601). Pass null to remove an existing expiration and make the link permanent. Omit this field entirely to leave expiration unchanged."
}
},
"additionalProperties": false
}