Record a customer event for a project. Requires the audience:write permission. Contact resolution is consent safe: profile fields may update, subscription status never changes. Send an Idempotency-Key header (or a body dedupeKey) for replay safety; without either, every call stores a distinct event. Events carrying identifiers.externalOrderId and a numeric properties.value are recorded as conversions attributed to the last email the contact clicked within five days.
API key authentication. Use 'Authorization: Bearer YOUR_API_KEY' where YOUR_API_KEY is obtained from the Migma dashboard under Settings → Developers → API Keys.
Contact identity for the event. At least one of email or subscriberId is required. Provider ids (externalCustomerId, externalCheckoutId, externalOrderId) support integrations and conversion attribution.
Event facts. Up to 16KB, 50 top-level keys, 4 levels deep. A numeric value (major units, e.g. 49.99) together with identifiers.externalOrderId records a conversion; currency is an ISO code, default USD.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"MigmaAI","description":"Learn how to create, review, send, and automate on-brand email with Migma, including campaigns, integrations, AI agents, and the API.","colors":{"primary":"#E02020","light":"#FF6B6B","dark":"#E02020"},"logo":{"light":"https://mintcdn.com/migmaai/Ddo1c-hiaq_XaPm5/logo/light.svg?fit=max\u0026auto=format\u0026n=Ddo1c-hiaq_XaPm5\u0026q=85\u0026s=932530a76040b68fd513f05d0d75522e","dark":"https://mintcdn.com/migmaai/Ddo1c-hiaq_XaPm5/logo/dark.svg?fit=max\u0026auto=format\u0026n=Ddo1c-hiaq_XaPm5\u0026q=85\u0026s=6fbca4044641719932190564e993c595","href":"https://migma.ai"},"favicon":"https://mintcdn.com/migmaai/6vIdVqfJZMkGpyl_/favicon.svg?fit=max\u0026auto=format\u0026n=6vIdVqfJZMkGpyl_\u0026q=85\u0026s=e5235d56cb1eaead4aa152c8dec7cdf7","api":{},"navbar":{"links":[{"href":"https://migma.ai/blog","label":"Blog","type":"link"},{"href":"https://docs.migma.ai/changelog","label":"Changelog","type":"link"}],"primary":{"type":"button","label":"Get started","href":"https://migma.ai"}},"footer":{"socials":{"twitter":"https://x.com/migma_ai","linkedin":"https://linkedin.com/company/migmaai"}},"search":{"prompt":"Search Migma documentation..."},"seo":{"metatags":{"canonical":"https://docs.migma.ai","author":"MigmaAI","robots":"index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1","googlebot":"index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1","language":"en","og:site_name":"MigmaAI","og:locale":"en_US","twitter:card":"summary_large_image","twitter:site":"@Migma_AI","twitter:creator":"@Migma_AI"},"organization":{"id":"https://migma.ai/#organization","name":"Migma","legalName":"MIGMAAI, INC.","url":"https://migma.ai","logo":"https://migma.ai/brandkit/cube/SVG/light.svg","sameAs":["https://x.com/migma_ai","https://www.linkedin.com/company/migmaai"]},"indexing":"navigable"},"styling":{"eyebrows":"breadcrumbs","latex":true},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"interaction":{},"metadata":{"timestamp":true},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"migmaai","hasAudioNarration":false,"actualSubdomain":"migmaai","customDomains":["docs.migma.ai"],"gitSource":{"type":"github","owner":"migmaai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aefedaac526d2ff3f072b8f","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API Reference","count":140},{"language":"default","tag":"API endpoints","count":131},{"language":"default","tag":"Changelog","count":93},{"language":"default","tag":"Human Guide","count":90},{"language":"default","tag":"Agents","count":25},{"language":"default","tag":"Integrations","count":23},{"language":"default","tag":"Emails","count":23},{"language":"default","tag":"August 2026","count":21},{"language":"default","tag":"Campaigns","count":18},{"language":"default","tag":"Domains","count":18}]},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@migma.ai","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6933a922f4841d58f56e8063","deploymentId":"6863fe6abbd816413cd3a806","questionText":"How do I integrate with the API?","status":"active","generatedBy":"manual","createdAt":"2025-12-06T03:55:14.525Z","updatedAt":"2025-12-06T03:55:14.525Z","__v":0},{"_id":"6933a91ff4841d58f56e7fe6","deploymentId":"6863fe6abbd816413cd3a806","questionText":"Can I preview emails across devices?","status":"active","generatedBy":"manual","createdAt":"2025-12-06T03:55:11.220Z","updatedAt":"2025-12-06T03:55:11.220Z","__v":0},{"_id":"6933a919f4841d58f56e7eea","deploymentId":"6863fe6abbd816413cd3a806","questionText":"How do I create emails with AI?","status":"active","generatedBy":"manual","createdAt":"2025-12-06T03:55:05.785Z","updatedAt":"2025-12-06T03:55:05.785Z","__v":0}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"html:not(.dark),html:not(.dark) body{background-color:#ffffff!important}html:not(.dark) #navbar .nav-tabs :is(a,button){color:#3f3a3a!important;font-weight:600!important}html:not(.dark) #navbar .nav-tabs :is(a,button):hover{color:#201d1d!important}html:not(.dark) #sidebar-content .sidebar-title,html:not(.dark) #sidebar-content h3,html:not(.dark) #sidebar .sidebar-title,html:not(.dark) #sidebar h3{color:#211f22!important;font-weight:600!important}html:not(.dark) #sidebar-content :is(a,button):not(.text-primary),html:not(.dark) #sidebar :is(a,button):not(.text-primary){color:#3f3a3a!important;font-weight:500!important}html:not(.dark) #sidebar-content :is(a,button):not(.text-primary):hover,html:not(.dark) #sidebar :is(a,button):not(.text-primary):hover{color:#201d1d!important}html:not(.dark) #sidebar-content :is(a,button):not([aria-current=\"page\"]):not(.text-primary) svg,html:not(.dark) #sidebar :is(a,button):not([aria-current=\"page\"]):not(.text-primary) svg,html:not(.dark) aside :is(a,button):not([aria-current=\"page\"]):not(.text-primary) svg{color:#34343a!important;opacity:1!important}html:not(.dark) #sidebar-content :is(a,button) img,html:not(.dark) #sidebar :is(a,button) img,html:not(.dark) aside :is(a,button) img{opacity:1!important;filter:brightness(0.9) saturate(1.1) contrast(1.12)}html.dark,html.dark body{background-color:#0e0b0d!important}html.dark #navbar .nav-tabs :is(a,button){color:#d4d4d8!important;font-weight:600!important}html.dark #navbar .nav-tabs :is(a,button):hover{color:#f9f9f9!important}html.dark #sidebar-content .sidebar-title,html.dark #sidebar-content h3,html.dark #sidebar .sidebar-title,html.dark #sidebar h3{color:#f9f9f9!important;font-weight:600!important}html.dark #sidebar-content :is(a,button):not(.text-primary),html.dark #sidebar :is(a,button):not(.text-primary){color:#a1a1aa!important;font-weight:500!important}html.dark #sidebar-content :is(a,button):not(.text-primary):hover,html.dark #sidebar :is(a,button):not(.text-primary):hover{color:#f9f9f9!important}html.dark #sidebar-content :is(a,button):not([aria-current=\"page\"]):not(.text-primary) svg,html.dark #sidebar :is(a,button):not([aria-current=\"page\"]):not(.text-primary) svg,html.dark aside :is(a,button):not([aria-current=\"page\"]):not(.text-primary) svg{color:#a1a1aa!important;opacity:1!important}html.dark #sidebar-content :is(a,button) img,html.dark #sidebar :is(a,button) img,html.dark aside :is(a,button) img{opacity:1!important;filter:brightness(1.05) saturate(1.05)}html:not(.dark) #sidebar-content :is(a,button).text-primary,html:not(.dark) #sidebar :is(a,button).text-primary{color:#e02020!important;font-weight:600!important}html.dark #sidebar-content :is(a,button).text-primary,html.dark #sidebar :is(a,button).text-primary{color:#ff6b6b!important;font-weight:600!important}#sidebar-content :is(a,button)[aria-current=\"page\"] svg,#sidebar :is(a,button)[aria-current=\"page\"] svg,aside :is(a,button)[aria-current=\"page\"] svg,#sidebar-content :is(a,button).text-primary svg,#sidebar :is(a,button).text-primary svg,aside :is(a,button).text-primary svg{color:#e02020!important;opacity:1!important}html.dark #sidebar-content :is(a,button)[aria-current=\"page\"] svg,html.dark #sidebar :is(a,button)[aria-current=\"page\"] svg,html.dark aside :is(a,button)[aria-current=\"page\"] svg,html.dark #sidebar-content :is(a,button).text-primary svg,html.dark #sidebar :is(a,button).text-primary svg,html.dark aside :is(a,button).text-primary svg{color:#ff6b6b!important;opacity:1!important}#content-area #content>span,#content-area #content li,#content-area #content table td,#content-area #content .steps .step p.mt-2{color:#514b4b!important}html.dark #content-area #content>span,html.dark #content-area #content li,html.dark #content-area #content table td,html.dark #content-area #content .steps .step p.mt-2{color:#c7c1c1!important}html:not(.dark) #content-area a.group>span{color:#5f5858!important}html.dark #content-area a.group>span{color:#918989!important}"}],"page":{"pagePath":"api-reference/events/track-event","slug":"/api-reference/events/track-event","pageMetadata":{"title":"Track Event","description":"Record a customer event for a project. Requires the audience:write permission. Contact resolution is consent safe: profile fields may update, subscription status never changes. Send an Idempotency-Key header (or a body dedupeKey) for replay safety; without either, every call stores a distinct event. Events carrying identifiers.externalOrderId and a numeric properties.value are recorded as conversions attributed to the last email the contact clicked within five days.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/events","href":"/api-reference/events/track-event","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Record a customer event for a project. Requires the audience:write permission. Contact resolution is consent safe: profile fields may update, subscription status never changes. Send an Idempotency-Key header (or a body dedupeKey) for replay safety; without either, every call stores a distinct event. Events carrying identifiers.externalOrderId and a numeric properties.value are recorded as conversions attributed to the last email the contact clicked within five days.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Track Event","description":"Record a customer event for a project. Requires the audience:write permission. Contact resolution is consent safe: profile fields may update, subscription status never changes. Send an Idempotency-Key header (or a body dedupeKey) for replay safety; without either, every call stores a distinct event. Events carrying identifiers.externalOrderId and a numeric properties.value are recorded as conversions attributed to the last email the contact clicked within five days.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/events","href":"/api-reference/events/track-event","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/migmaai/a5e69fc95e43b27a/title-format.js"],"openApiReferenceData":{"operation":{"tags":["Events"],"summary":"Track Event","operationId":"TrackEvent","description":"Record a customer event for a project. Requires the audience:write permission. Contact resolution is consent safe: profile fields may update, subscription status never changes. Send an Idempotency-Key header (or a body dedupeKey) for replay safety; without either, every call stores a distinct event. Events carrying identifiers.externalOrderId and a numeric properties.value are recorded as conversions attributed to the last email the contact clicked within five days.","parameters":["393a4a11-058f-409e-af54-b24fafefafbb"],"requestBody":"80c0af67-3eb7-4d8c-8168-b3559690b3d5","responses":{"201":"2bc812b0-3ba7-4e64-8082-8fbe00241b27","400":"64f0b6f3-b3b7-479a-b340-e2fa56670294","401":"fa3ec3c5-f779-4cff-9ac0-298a8bbce2e4","403":"d903fec5-be4c-47b2-a3ad-a91450ff323b","404":"1494b169-2a0a-42c5-88bb-e8c9c1ee691c"},"method":"post","type":"path","servers":["7b46b2df-ccb5-4dcc-a5f6-b1e33702d576"],"security":["69985392-7d34-4c30-b901-e73928f3eafa"],"path":"/v1/events","baseUrlOptions":["https://api.migma.ai"],"title":"Track Event","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"393a4a11-058f-409e-af54-b24fafefafbb":{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":200,"isRequired":false,"description":"Replay-safe key. Takes precedence over the body dedupeKey.","uniqueKey":"","typeLabel":"string"},"description":"Replay-safe key. Takes precedence over the body dedupeKey."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projectId","name","identifiers"],"properties":{"projectId":{"type":"string","isRequired":true,"uniqueKey":"projectId","typeLabel":"string"},"name":{"type":"string","maxLength":120,"description":"Event name, e.g. purchase.completed. Names containing refund or cancelled record negative conversion amounts.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"identifiers":{"type":"object","description":"Contact identity for the event. At least one of email or subscriberId is required. Provider ids (externalCustomerId, externalCheckoutId, externalOrderId) support integrations and conversion attribution.","properties":{"email":{"type":"string","format":"email","uniqueKey":"identifiers.email","typeLabel":"string\u003cemail>"},"subscriberId":{"type":"string","uniqueKey":"identifiers.subscriberId","typeLabel":"string"},"externalCustomerId":{"type":"string","maxLength":200,"uniqueKey":"identifiers.externalCustomerId","typeLabel":"string"},"externalCheckoutId":{"type":"string","maxLength":200,"uniqueKey":"identifiers.externalCheckoutId","typeLabel":"string"},"externalOrderId":{"type":"string","maxLength":200,"description":"The provider's order or charge id. Required for the event to record a conversion.","uniqueKey":"identifiers.externalOrderId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"identifiers","typeLabel":"object"},"origin":{"type":"string","maxLength":80,"default":"api","uniqueKey":"origin","typeLabel":"string"},"eventVersion":{"type":"string","maxLength":40,"uniqueKey":"eventVersion","typeLabel":"string"},"profile":{"type":"object","description":"Contact metadata to update. Profile updates never change subscription status, tags, or consent. Events never opt a contact in.","properties":{"firstName":{"type":"string","maxLength":120,"uniqueKey":"profile.firstName","typeLabel":"string"},"lastName":{"type":"string","maxLength":120,"uniqueKey":"profile.lastName","typeLabel":"string"},"phone":{"type":"string","maxLength":80,"uniqueKey":"profile.phone","typeLabel":"string"},"country":{"type":"string","maxLength":80,"uniqueKey":"profile.country","typeLabel":"string"},"language":{"type":"string","maxLength":40,"uniqueKey":"profile.language","typeLabel":"string"},"customFields":{"type":"object","additionalProperties":true,"uniqueKey":"profile.customFields","typeLabel":"object"}},"uniqueKey":"profile","typeLabel":"object"},"properties":{"type":"object","additionalProperties":true,"description":"Event facts. Up to 16KB, 50 top-level keys, 4 levels deep. A numeric value (major units, e.g. 49.99) together with identifiers.externalOrderId records a conversion; currency is an ISO code, default USD.","uniqueKey":"properties","typeLabel":"object"},"occurredAt":{"type":"string","format":"date-time","description":"When the event happened. Defaults to receipt time.","uniqueKey":"occurredAt","typeLabel":"string\u003cdate-time>"},"dedupeKey":{"type":"string","maxLength":200,"description":"Event-identity dedupe key. Replaying the same key stores nothing and returns the original eventId.","uniqueKey":"dedupeKey","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"projectId":"PROJECT_ID","name":"purchase.completed","identifiers":{"email":"ada@example.com","externalOrderId":"order_8891"},"properties":{"value":49.99,"currency":"USD"}},"examples":{"Example":{"title":"Example","value":{"projectId":"PROJECT_ID","name":"purchase.completed","identifiers":{"email":"ada@example.com","externalOrderId":"order_8891"},"properties":{"value":49.99,"currency":"USD"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"2bc812b0-3ba7-4e64-8082-8fbe00241b27":{"description":"Event stored (or replayed)","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"type":"object","properties":{"stored":{"type":"boolean","description":"false when the dedupeKey was seen before; eventId then refers to the original event.","uniqueKey":"data.stored","typeLabel":"boolean"},"eventId":{"type":"string","uniqueKey":"data.eventId","typeLabel":"string"},"dedupeKey":{"type":"string","uniqueKey":"data.dedupeKey","typeLabel":"string"}},"uniqueKey":"data","typeLabel":"object"},"error":{"oneOf":[{"type":"string","uniqueKey":"error.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"stored":true,"eventId":"\u003cstring>","dedupeKey":"\u003cstring>"},"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"64f0b6f3-b3b7-479a-b340-e2fa56670294":{"description":"Validation failed or no contact identifier","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"oneOf":[{},{"type":"null","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"null"},"error":{"oneOf":[{"type":"string","uniqueKey":"error.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"string | null"}},"required":["success"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"data":"\u003cunknown>","error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"fa3ec3c5-f779-4cff-9ac0-298a8bbce2e4":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"oneOf":[{},{"type":"null","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"null"},"error":{"oneOf":[{"type":"string","uniqueKey":"error.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"string | null"}},"required":["success"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"data":"\u003cunknown>","error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"d903fec5-be4c-47b2-a3ad-a91450ff323b":{"description":"Missing audience:write permission or no access to the project","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"oneOf":[{},{"type":"null","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"null"},"error":{"oneOf":[{"type":"string","uniqueKey":"error.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"string | null"}},"required":["success"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"data":"\u003cunknown>","error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"1494b169-2a0a-42c5-88bb-e8c9c1ee691c":{"description":"Subscriber not found in this project","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"oneOf":[{},{"type":"null","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"null"},"error":{"oneOf":[{"type":"string","uniqueKey":"error.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"string | null"}},"required":["success"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"data":"\u003cunknown>","error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"69985392-7d34-4c30-b901-e73928f3eafa":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key authentication. Use 'Authorization: Bearer YOUR_API_KEY' where YOUR_API_KEY is obtained from the Migma dashboard under Settings → Developers → API Keys.","scopes":[],"schemeName":"apiKeyAuth"}}},"servers":{"7b46b2df-ccb5-4dcc-a5f6-b1e33702d576":{"url":"https://api.migma.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"API key authentication. Use 'Authorization: Bearer YOUR_API_KEY' where YOUR_API_KEY is obtained from the Migma dashboard under Settings → Developers → API Keys.","scopes":[],"schemeName":"apiKeyAuth"},"schema":{"title":"Authorization","type":"string","description":"API key authentication. Use 'Authorization: Bearer YOUR_API_KEY' where YOUR_API_KEY is obtained from the Migma dashboard under Settings → Developers → API Keys.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"Authorization"}],"title":"apiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"migmaai","siteName":"MigmaAI","title":"Track Event - MigmaAI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/events/track-event.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Record a customer event for a project. Requires the audience:write permission. Contact resolution is consent safe: profile fields may update, subscription status never changes. Send an Idempotency-Key header (or a body dedupeKey) for replay safety; without either, every call stores a distinct event. Events carrying identifiers.externalOrderId and a numeric properties.value are recorded as conversions attributed to the last email the contact clicked within five days.\">\u003cmeta data-mint-head name=\"application-name\" content=\"MigmaAI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/migmaai/hy0px75GoiudrnlD/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/migmaai/hy0px75GoiudrnlD/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/migmaai/hy0px75GoiudrnlD/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/migmaai/hy0px75GoiudrnlD/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/migmaai/hy0px75GoiudrnlD/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/migmaai/hy0px75GoiudrnlD/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/migmaai/hy0px75GoiudrnlD/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/migmaai/hy0px75GoiudrnlD/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/migmaai/hy0px75GoiudrnlD/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Track Event - MigmaAI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Record a customer event for a project. Requires the audience:write permission. Contact resolution is consent safe: profile fields may update, subscription status never changes. Send an Idempotency-Key header (or a body dedupeKey) for replay safety; without either, every call stores a distinct event. Events carrying identifiers.externalOrderId and a numeric properties.value are recorded as conversions attributed to the last email the contact clicked within five days.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"MigmaAI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.migma.ai/api-reference/events/track-event\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://migmaai.mintlify.site/_mintlify/api/og/v2?division=Events\u0026amp;title=Track+Event\u0026amp;description=Record+a+customer+event+for+a+project.+Requires+the+audience%3Awrite+permission.+Contact+resolution+is+consent+safe%3A+profile+fields+may+update%2C+subscription+statu\u0026amp;theme=068ad8bd6faaa583ce519c6c\u0026amp;signature=5a82f07df693807c8a8fcb201d42b2d75ff45073346d97131927660dac282b48\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Track Event - MigmaAI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Record a customer event for a project. Requires the audience:write permission. Contact resolution is consent safe: profile fields may update, subscription status never changes. Send an Idempotency-Key header (or a body dedupeKey) for replay safety; without either, every call stores a distinct event. Events carrying identifiers.externalOrderId and a numeric properties.value are recorded as conversions attributed to the last email the contact clicked within five days.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://migmaai.mintlify.site/_mintlify/api/og/v2?division=Events\u0026amp;title=Track+Event\u0026amp;description=Record+a+customer+event+for+a+project.+Requires+the+audience%3Awrite+permission.+Contact+resolution+is+consent+safe%3A+profile+fields+may+update%2C+subscription+statu\u0026amp;theme=068ad8bd6faaa583ce519c6c\u0026amp;signature=5a82f07df693807c8a8fcb201d42b2d75ff45073346d97131927660dac282b48\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/migmaai/hy0px75GoiudrnlD/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"MigmaAI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#E02020\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"author\" content=\"MigmaAI\">\u003cmeta data-mint-head name=\"googlebot\" content=\"index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1\">\u003cmeta data-mint-head name=\"language\" content=\"en\">\u003cmeta data-mint-head name=\"twitter:creator\" content=\"@Migma_AI\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.migma.ai/api-reference/events/track-event\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/events/track-event.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://migma.ai/#organization\",\"name\":\"Migma\",\"legalName\":\"MIGMAAI, INC.\",\"url\":\"https://migma.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://migma.ai/brandkit/cube/SVG/light.svg\"},\"sameAs\":[\"https://x.com/migma_ai\",\"https://www.linkedin.com/company/migmaai\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.migma.ai#website\",\"name\":\"MigmaAI\",\"url\":\"https://docs.migma.ai\",\"publisher\":{\"@id\":\"https://migma.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.migma.ai/api-reference/events/track-event#webpage\",\"url\":\"https://docs.migma.ai/api-reference/events/track-event\",\"name\":\"Track Event\",\"description\":\"Record a customer event for a project. Requires the audience:write permission. Contact resolution is consent safe: profile fields may update, subscription status never changes. Send an Idempotency-Key header (or a body dedupeKey) for replay safety; without either, every call stores a distinct event. Events carrying identifiers.externalOrderId and a numeric properties.value are recorded as conversions attributed to the last email the contact clicked within five days.\",\"isPartOf\":{\"@id\":\"https://docs.migma.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.migma.ai/api-reference/events/track-event#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.migma.ai/api-reference/events/track-event#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API endpoints\",\"item\":\"https://docs.migma.ai/api-reference/projectsbrands/list-projects\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Track Event\",\"item\":\"https://docs.migma.ai/api-reference/events/track-event\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.migma.ai/api-reference/events/track-event#apireference\",\"headline\":\"Track Event\",\"name\":\"Track Event\",\"description\":\"Record a customer event for a project. Requires the audience:write permission. Contact resolution is consent safe: profile fields may update, subscription status never changes. Send an Idempotency-Key header (or a body dedupeKey) for replay safety; without either, every call stores a distinct event. Events carrying identifiers.externalOrderId and a numeric properties.value are recorded as conversions attributed to the last email the contact clicked within five days.\",\"url\":\"https://docs.migma.ai/api-reference/events/track-event\",\"mainEntityOfPage\":{\"@id\":\"https://docs.migma.ai/api-reference/events/track-event#webpage\"},\"publisher\":{\"@id\":\"https://migma.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.migma.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"MigmaAI\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"MigmaAI","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Human Guide","icon":"book-open","pages":[{"title":"Human Guide","href":"/get-started/what-is-migma"}]},{"tab":"Integrations","icon":"puzzle-piece","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"Agents","icon":"microchip","pages":[{"title":"Agents","href":"/agents/overview"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Overview","pages":[{"title":"Migma Email API Reference","sidebarTitle":"API Reference","icon":"book-open","href":"/api-reference/introduction"},{"title":"Migma API Quickstart","sidebarTitle":"Quickstart","icon":"bolt","href":"/quickstart"},{"title":"Authenticate Migma API Requests","sidebarTitle":"Authentication","icon":"key","href":"/authentication"}]},{"group":"Developer Tools","pages":[{"title":"Migma Node.js SDK","sidebarTitle":"SDK","icon":"https://mintlify.s3.us-west-1.amazonaws.com/migmaai/images/logos/npm.svg","href":"/sdk"},{"title":"Migma CLI Reference","sidebarTitle":"CLI","icon":"terminal","href":"/cli"},{"title":"Migma Email Preview API","sidebarTitle":"Email Preview API","icon":"eye","href":"/api-preview"}]},{"group":"Guides","pages":[{"title":"Events \u0026 Webhooks","icon":"bell","href":"/webhooks"},{"title":"Track Customer Events with the Migma API","sidebarTitle":"Events","icon":"bolt","href":"/events"},{"title":"Automate Migma with n8n","sidebarTitle":"n8n Integration","icon":"https://mintlify.s3.us-west-1.amazonaws.com/migmaai/images/logos/n8n.svg","href":"/n8n"}]},{"group":"API endpoints","pages":[{"group":"Projects/Brands","pages":[{"title":"List Projects","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects","href":"/api-reference/projectsbrands/list-projects"},{"title":"Get Project Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}","href":"/api-reference/projectsbrands/get-project-details"},{"title":"Get Project Field Catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/field-catalog","href":"/api-reference/projectsbrands/get-project-field-catalog"},{"title":"Import Project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/import","href":"/api-reference/projectsbrands/import-project"},{"title":"Create Sample Brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/sample","href":"/api-reference/projectsbrands/create-sample-brand"},{"title":"Create Brand From Name","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/from-name","href":"/api-reference/projectsbrands/create-brand-from-name"},{"title":"Get Import Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/import/{projectId}/status","href":"/api-reference/projectsbrands/get-import-status"},{"title":"Retry Import","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/import/{projectId}/retry","href":"/api-reference/projectsbrands/retry-import"},{"title":"List Brand Suggestions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/insights","href":"/api-reference/projectsbrands/list-brand-suggestions"},{"title":"Add Calendar Event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/insights/events","href":"/api-reference/projectsbrands/add-calendar-event"},{"title":"Remove Calendar Event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/projects/{projectId}/insights/events/{eventId}","href":"/api-reference/projectsbrands/remove-calendar-event"},{"title":"Complete Calendar Event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/insights/events/{eventId}/complete","href":"/api-reference/projectsbrands/complete-calendar-event"},{"title":"List Workspaces","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workspaces","href":"/api-reference/projectsbrands/list-workspaces"}]},{"group":"Emails","pages":[{"title":"List Emails","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/emails","href":"/api-reference/emails/list-emails"},{"title":"Generate Email (Async)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/emails/generate","href":"/api-reference/emails/generate-email-async"},{"title":"Import HTML Email (Async)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/emails/import-html","href":"/api-reference/emails/import-html-email-async"},{"title":"Get Email Generation Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/emails/{conversationId}/status","href":"/api-reference/emails/get-email-generation-status"},{"title":"Send Test Email","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/emails/test/send","href":"/api-reference/emails/send-test-email"},{"title":"Send Email","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/sending","href":"/api-reference/emails/send-email"},{"title":"Get Batch Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/sending/batches/{batchId}","href":"/api-reference/emails/get-batch-status"},{"title":"Get Sending Metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/metrics/sending","href":"/api-reference/emails/get-sending-metrics"},{"title":"Export HTML","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/export/html/{conversationId}","href":"/api-reference/emails/export-html"},{"title":"Export Klaviyo","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/export/klaviyo/{conversationId}","href":"/api-reference/emails/export-klaviyo"},{"title":"Export Mailchimp","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/export/mailchimp/{conversationId}","href":"/api-reference/emails/export-mailchimp"},{"title":"Export HubSpot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/export/hubspot","href":"/api-reference/emails/export-hubspot"},{"title":"Get Export Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/export/status/{conversationId}","href":"/api-reference/emails/get-export-status"},{"title":"List Export Formats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/export/formats","href":"/api-reference/emails/list-export-formats"},{"title":"Get Email","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/emails/{emailId}","href":"/api-reference/emails/get-email"},{"title":"Get Email Metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/emails/{emailId}/metrics","href":"/api-reference/emails/get-email-metrics"},{"title":"Get Email Logs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/emails/{emailId}/logs","href":"/api-reference/emails/get-email-logs"},{"title":"Edit Email With Prompt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/emails/{emailId}/edit","href":"/api-reference/emails/edit-email-with-prompt"},{"title":"Get Email Edit Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/emails/{emailId}/edits/{editId}","href":"/api-reference/emails/get-email-edit-status"},{"title":"Export PDF","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/export/pdf/{conversationId}","href":"/api-reference/emails/export-pdf"},{"title":"Export PNG","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/export/png/{conversationId}","href":"/api-reference/emails/export-png"},{"title":"Request a send approval","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/send-approvals","href":"/api-reference/emails/request-a-send-approval"},{"title":"Get a send approval","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/send-approvals/{id}","href":"/api-reference/emails/get-a-send-approval"}]},{"group":"Email Validation","pages":[{"title":"Check Email Compatibility","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/emails/validate/compatibility","href":"/api-reference/email-validation/check-email-compatibility"},{"title":"Analyze Email Links","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/emails/validate/links","href":"/api-reference/email-validation/analyze-email-links"},{"title":"Check Spelling \u0026 Grammar","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/emails/validate/spelling","href":"/api-reference/email-validation/check-spelling-\u0026-grammar"},{"title":"Analyze Email Deliverability","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/emails/validate/deliverability","href":"/api-reference/email-validation/analyze-email-deliverability"},{"title":"Run All Validation Checks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/emails/validate/all","href":"/api-reference/email-validation/run-all-validation-checks"}]},{"group":"Email Previews","pages":[{"title":"Create Email Preview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/emails/previews","href":"/api-reference/email-previews/create-email-preview"},{"title":"Get Preview Status and Results","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/emails/previews/{previewId}","href":"/api-reference/email-previews/get-preview-status-and-results"},{"title":"Get Preview Status Only","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/emails/previews/{previewId}/status","href":"/api-reference/email-previews/get-preview-status-only"},{"title":"Get Specific Device Preview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/emails/previews/{previewId}/devices/{deviceKey}","href":"/api-reference/email-previews/get-specific-device-preview"},{"title":"Get Supported Devices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/emails/devices/supported","href":"/api-reference/email-previews/get-supported-devices"}]},{"group":"Integrations","pages":[{"title":"Connect Shopify Store","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/shopify/connect","href":"/api-reference/integrations/connect-shopify-store"}]},{"group":"Contacts","pages":[{"title":"List Contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Add Contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts","href":"/api-reference/contacts/add-contact"},{"title":"Bulk Import Contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts/bulk","href":"/api-reference/contacts/bulk-import-contacts"},{"title":"Get Bulk Import Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts/bulk/{jobId}","href":"/api-reference/contacts/get-bulk-import-status"},{"title":"Batch Delete Contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts/bulk-delete","href":"/api-reference/contacts/batch-delete-contacts"},{"title":"Create Contact Import","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts/imports","href":"/api-reference/contacts/create-contact-import"},{"title":"Get Contact Import","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts/imports/{id}","href":"/api-reference/contacts/get-contact-import"},{"title":"List Provider Import Sources","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts/imports/providers/{provider}/sources","href":"/api-reference/contacts/list-provider-import-sources"},{"title":"Create Provider Contact Import","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts/imports/provider","href":"/api-reference/contacts/create-provider-contact-import"},{"title":"Change Contact Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts/status","href":"/api-reference/contacts/change-contact-status"},{"title":"Get Contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts/{id}","href":"/api-reference/contacts/get-contact"},{"title":"Delete Contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/contacts/{id}","href":"/api-reference/contacts/delete-contact"},{"title":"Update Contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/contacts/{id}","href":"/api-reference/contacts/update-contact"},{"title":"Create Contact Export","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts/exports","href":"/api-reference/contacts/create-contact-export"},{"title":"Get Contact Export","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts/exports/{jobId}","href":"/api-reference/contacts/get-contact-export"}]},{"group":"Tags","pages":[{"title":"List Tags","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tags","href":"/api-reference/tags/list-tags"},{"title":"Create Tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tags","href":"/api-reference/tags/create-tag"},{"title":"Get Tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tags/{id}","href":"/api-reference/tags/get-tag"},{"title":"Delete Tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/tags/{id}","href":"/api-reference/tags/delete-tag"},{"title":"Update Tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/tags/{id}","href":"/api-reference/tags/update-tag"}]},{"group":"Topics","pages":[{"title":"List Topics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/topics","href":"/api-reference/topics/list-topics"},{"title":"Create Topic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/topics","href":"/api-reference/topics/create-topic"},{"title":"Get Topic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/topics/{id}","href":"/api-reference/topics/get-topic"},{"title":"Delete Topic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/topics/{id}","href":"/api-reference/topics/delete-topic"},{"title":"Update Topic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/topics/{id}","href":"/api-reference/topics/update-topic"},{"title":"Subscribe Contact to Topic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/topics/{id}/subscribe","href":"/api-reference/topics/subscribe-contact-to-topic"},{"title":"Unsubscribe Contact from Topic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/topics/{id}/unsubscribe","href":"/api-reference/topics/unsubscribe-contact-from-topic"}]},{"group":"Segments","pages":[{"title":"List Segments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/segments","href":"/api-reference/segments/list-segments"},{"title":"Create Segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/segments","href":"/api-reference/segments/create-segment"},{"title":"Get Segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/segments/{id}","href":"/api-reference/segments/get-segment"},{"title":"Delete Segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/segments/{id}","href":"/api-reference/segments/delete-segment"},{"title":"Update Segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/segments/{id}","href":"/api-reference/segments/update-segment"}]},{"group":"Domains","pages":[{"title":"List Domains","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/domains","href":"/api-reference/domains/list-domains"},{"title":"Add Domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/domains","href":"/api-reference/domains/add-domain"},{"title":"Get Domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/domains/{domain}","href":"/api-reference/domains/get-domain"},{"title":"Delete Domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/domains/{domain}","href":"/api-reference/domains/delete-domain"},{"title":"Update Domain Settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/domains/{domain}","href":"/api-reference/domains/update-domain-settings"},{"title":"Verify Domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/domains/{domain}/verify","href":"/api-reference/domains/verify-domain"},{"title":"Check Subdomain Availability","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/domains/managed/check/{prefix}","href":"/api-reference/domains/check-subdomain-availability"},{"title":"Provision Stream Identity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/domains/streams","href":"/api-reference/domains/provision-stream-identity"},{"title":"List Managed Domains","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/domains/managed","href":"/api-reference/domains/list-managed-domains"},{"title":"Create Managed Domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/domains/managed","href":"/api-reference/domains/create-managed-domain"},{"title":"Delete Managed Domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/domains/managed/{domain}","href":"/api-reference/domains/delete-managed-domain"},{"title":"Set Up Domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/domains/setup","href":"/api-reference/domains/set-up-domain"},{"title":"Search Buyable Domains","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/domains/purchase/search","href":"/api-reference/domains/search-buyable-domains"},{"title":"Purchase Domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/domains/purchase","href":"/api-reference/domains/purchase-domain"},{"title":"List Domain Purchases","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/domains/purchase/registrations","href":"/api-reference/domains/list-domain-purchases"},{"title":"List DNS Records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/domains/{domain}/dns-records","href":"/api-reference/domains/list-dns-records"},{"title":"Add DNS Record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/domains/{domain}/dns-records","href":"/api-reference/domains/add-dns-record"},{"title":"Remove DNS Record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/domains/{domain}/dns-records/{recordId}","href":"/api-reference/domains/remove-dns-record"}]},{"group":"Campaigns","pages":[{"title":"List Campaigns","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"Create Campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns","href":"/api-reference/campaigns/create-campaign"},{"title":"Get Campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns/{id}","href":"/api-reference/campaigns/get-campaign"},{"title":"Send Campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{id}/send","href":"/api-reference/campaigns/send-campaign"},{"title":"Schedule Campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{id}/schedule","href":"/api-reference/campaigns/schedule-campaign"},{"title":"Cancel Campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{id}/cancel","href":"/api-reference/campaigns/cancel-campaign"},{"title":"Archive Campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{id}/archive","href":"/api-reference/campaigns/archive-campaign"},{"title":"Unarchive Campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{id}/unarchive","href":"/api-reference/campaigns/unarchive-campaign"},{"title":"Get Campaign Stats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns/{id}/stats","href":"/api-reference/campaigns/get-campaign-stats"},{"title":"Get Campaign Logs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns/{id}/logs","href":"/api-reference/campaigns/get-campaign-logs"}]},{"group":"Webhooks","pages":[{"title":"List Webhooks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Create Webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhooks","href":"/api-reference/webhooks/create-webhook"},{"title":"Get Webhook Stats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhooks/stats","href":"/api-reference/webhooks/get-webhook-stats"},{"title":"List Event Types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhooks/events","href":"/api-reference/webhooks/list-event-types"},{"title":"Get Webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhooks/{webhookId}","href":"/api-reference/webhooks/get-webhook"},{"title":"Delete Webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/webhooks/{webhookId}","href":"/api-reference/webhooks/delete-webhook"},{"title":"Update Webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/webhooks/{webhookId}","href":"/api-reference/webhooks/update-webhook"},{"title":"Test Webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhooks/{webhookId}/test","href":"/api-reference/webhooks/test-webhook"},{"title":"Get Webhook Deliveries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhooks/{webhookId}/deliveries","href":"/api-reference/webhooks/get-webhook-deliveries"}]},{"group":"Project Editing","pages":[{"title":"Update Image Metadata","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/projects/{projectId}/images","href":"/api-reference/project-editing/update-image-metadata"},{"title":"Add Image","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/images","href":"/api-reference/project-editing/add-image"},{"title":"Remove Image","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/projects/{projectId}/images","href":"/api-reference/project-editing/remove-image"},{"title":"List Knowledge Base Entries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/knowledge-base","href":"/api-reference/project-editing/list-knowledge-base-entries"},{"title":"Add Knowledge Base Entry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/knowledge-base","href":"/api-reference/project-editing/add-knowledge-base-entry"},{"title":"Update Knowledge Base Entry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/projects/{projectId}/knowledge-base/{entryId}","href":"/api-reference/project-editing/update-knowledge-base-entry"},{"title":"Remove Knowledge Base Entry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/projects/{projectId}/knowledge-base/{entryId}","href":"/api-reference/project-editing/remove-knowledge-base-entry"},{"title":"Update Logos","description":"Update project logos (primary, secondary, favicon). Requires project:write permission.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/projects/{projectId}/logos","href":"/api-reference/project-editing/update-logos"}]},{"group":"Events","pages":[{"title":"Track Event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/events","href":"/api-reference/events/track-event"},{"title":"Track Events (Batch)","description":"Record up to 500 events in one request with row-level partial success: one malformed row never fails the batch. Idempotency is per row via dedupeKey; a request-level Idempotency-Key header is rejected. Aggregate properties payloads are limited to 1MB.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/events/batch","href":"/api-reference/events/track-events-batch"}]},{"group":"Billing","pages":[{"title":"Get Credits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/billing/credits","href":"/api-reference/billing/get-credits"},{"title":"Create Upgrade Link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/billing/upgrade-link","href":"/api-reference/billing/create-upgrade-link"}]},{"group":"Projects","pages":[{"title":"List Connected Tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/connected-tools","href":"/api-reference/projects/list-connected-tools"},{"title":"Get Connected Tool Schema","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/connected-tools/schema","href":"/api-reference/projects/get-connected-tool-schema"},{"title":"Call Connected Tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/connected-tools/call","href":"/api-reference/projects/call-connected-tool"}]}]}]},{"tab":"Legal","icon":"scale-balanced","pages":[{"title":"Legal","href":"/legal/acceptable-use"}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Track Event - MigmaAI","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}