These fields are optional enrichment data. They don’t drive attribution, but they make lead and sale records significantly more useful in analytics and reporting.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"CutMe Short","colors":{"primary":"#602fd2","light":"#EBE6FA","dark":"#552ACC"},"logo":{"light":"https://mintcdn.com/cutmeshort/DjXa7XIcYuaTMlzC/logo/cms.svg?fit=max\u0026auto=format\u0026n=DjXa7XIcYuaTMlzC\u0026q=85\u0026s=66a6213599d5bb3fc1a233f9ac11345b","dark":"https://mintcdn.com/cutmeshort/HKA1wkEul7pDa24-/logo/dark.svg?fit=max\u0026auto=format\u0026n=HKA1wkEul7pDa24-\u0026q=85\u0026s=04d1f24f22d1172500d3da2e5af3cbdc"},"favicon":"https://mintcdn.com/cutmeshort/HKA1wkEul7pDa24-/favicon.svg?fit=max\u0026auto=format\u0026n=HKA1wkEul7pDa24-\u0026q=85\u0026s=e07fa80e3ab28458ef370cbd0de3eb45","api":{"openapi":"api-reference/openapi.json"},"appearance":{"default":"light","strict":true},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://app.cutmeshort.com"}},"footer":{"socials":{"website":"https://www.cutmeshort.com/","twitter":"https://twitter.com/cut_me_short","linkedin":"https://www.linkedin.com/company/cutme-short"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cutmeshort","hasAudioNarration":false,"actualSubdomain":"cutmeshort","customDomains":["docs.cutmeshort.com"],"gitSource":{"type":"github","owner":"cut-me-short","repo":"docs-main","deployBranch":"sdk","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae91fa549359631f68619f1:success","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"Features","count":22},{"language":"default","tag":"API Docs","count":12},{"language":"default","tag":"SDKs","count":6},{"language":"default","tag":"Links","count":5},{"language":"default","tag":"Attribution","count":4},{"language":"default","tag":"Domain","count":4},{"language":"default","tag":"Server-side","count":3},{"language":"default","tag":"Tags","count":2},{"language":"default","tag":"Getting Started","count":2},{"language":"default","tag":"Client-side","count":2}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/field","slug":"/api-reference/endpoint/field","pageMetadata":{"title":"Field Reference","description":"Complete reference for attribution, conversion, and user detail fields used in lead and sale tracking.","href":"/api-reference/endpoint/field"},"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: \"Complete reference for attribution, conversion, and user detail fields used in lead and sale tracking.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,blockquote:`blockquote`,code:`code`,em:`em`,li:`li`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Table,Warning}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`attribution-fields`,children:`Attribution Fields`}),`\n`,_jsxs(_components.p,{children:[`These fields form the backbone of click-to-conversion tracking. They tell CutMeShort `,_jsx(_components.em,{children:`where`}),` a conversion came from and `,_jsx(_components.em,{children:`who`}),` made it.`]}),`\n`,_jsx(Heading,{level:`3`,id:`clickid`,children:_jsx(_components.code,{children:`clickId`})}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Never generate your own `,_jsx(_components.code,{children:`clickId`}),`. Always reuse the value created by the tracking script.`]})}),`\n`,_jsx(_components.p,{children:`The click-level attribution identifier — the unique fingerprint of the original tracked click.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Property`}),_jsx(_components.th,{children:`Detail`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Source`})}),_jsxs(_components.td,{children:[`CutMeShort captures it when the script detects `,_jsx(_components.code,{children:`cms_rf`}),` in the URL`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Storage`})}),_jsx(_components.td,{children:`Persisted in cookies by the tracking script for later reuse`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Usage`})}),_jsx(_components.td,{children:`Pass in lead and sale events to link conversions back to the originating click`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`customerexternalid`,children:_jsx(_components.code,{children:`customerExternalId`})}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Do not create a new value at sale time or in follow-up lead events. Use the same identifier across all events for the same customer.`})}),`\n`,_jsx(_components.p,{children:`Your stable customer identifier — the consistent key that connects a customer’s journey end-to-end.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Property`}),_jsx(_components.th,{children:`Detail`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Source`})}),_jsx(_components.td,{children:`Your application, auth system, CRM, or backend user record`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Usage`})}),_jsx(_components.td,{children:`Keep it unchanged across lead and sale events`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Purpose`})}),_jsx(_components.td,{children:`Allows CutMeShort to stitch the full customer journey together`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`eventname`,children:_jsx(_components.code,{children:`eventName`})}),`\n`,_jsx(_components.p,{children:`A human-readable label describing the lead milestone being recorded.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Property`}),_jsx(_components.th,{children:`Detail`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Examples`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`signup_started`}),`, `,_jsx(_components.code,{children:`email_verified`}),`, `,_jsx(_components.code,{children:`purchase_completed`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Source`})}),_jsx(_components.td,{children:`Your product logic or event naming convention`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Usage`})}),_jsx(_components.td,{children:`Send a meaningful name that describes exactly what lead action occurred`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`mode`,children:_jsx(_components.code,{children:`mode`})}),`\n`,_jsxs(_components.blockquote,{children:[`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Deferred lead flows only.`}),` Only use this on the initial event of a deferred tracking sequence.`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`A flag that controls how lead attribution is recorded when you need to defer tracking.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Property`}),_jsx(_components.th,{children:`Detail`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Valid value`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`\"deferred\"`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Source`})}),_jsx(_components.td,{children:`Set by your app when you intentionally want deferred tracking`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Usage`})}),_jsxs(_components.td,{children:[`Set to `,_jsx(_components.code,{children:`\"deferred\"`}),` for the first event in a deferred lead flow only`]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`conversion-fields`,children:`Conversion Fields`}),`\n`,_jsx(_components.p,{children:`These fields carry the financial and transactional data for a sale event.`}),`\n`,_jsx(Heading,{level:`3`,id:`amount`,children:_jsx(_components.code,{children:`amount`})}),`\n`,_jsx(_components.p,{children:`The monetary value associated with the sale.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Property`}),_jsx(_components.th,{children:`Detail`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Source`})}),_jsx(_components.td,{children:`Your payment provider, checkout session, order record, or billing backend`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Usage`})}),_jsx(_components.td,{children:`Send the final sale amount for the conversion being attributed`})]})]})]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Make sure the value matches the currency you send alongside it.`})}),`\n`,_jsx(Heading,{level:`3`,id:`currency`,children:_jsx(_components.code,{children:`currency`})}),`\n`,_jsx(_components.p,{children:`The ISO 4217 currency code for the sale amount.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Property`}),_jsx(_components.th,{children:`Detail`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Format`})}),_jsxs(_components.td,{children:[`3-letter ISO code — e.g. `,_jsx(_components.code,{children:`USD`}),`, `,_jsx(_components.code,{children:`EUR`}),`, `,_jsx(_components.code,{children:`INR`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Source`})}),_jsx(_components.td,{children:`Your billing or checkout system`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Usage`})}),_jsxs(_components.td,{children:[`Always pair with the `,_jsx(_components.code,{children:`amount`}),` field`]})]})]})]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Keep the code consistent with the actual transaction currency to ensure accurate revenue reporting.`})}),`\n`,_jsx(Heading,{level:`3`,id:`invoiceid`,children:_jsx(_components.code,{children:`invoiceId`})}),`\n`,_jsx(_components.p,{children:`The unique transaction or order reference for a sale.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Property`}),_jsx(_components.th,{children:`Detail`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Source`})}),_jsx(_components.td,{children:`Your payment processor, order table, or billing system`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Usage`})}),_jsx(_components.td,{children:`Use to deduplicate repeated submissions and reconcile revenue events`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Stability`})}),_jsx(_components.td,{children:`Must remain the same for the same transaction`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`user-detail-fields`,children:`User Detail Fields`}),`\n`,_jsxs(_components.p,{children:[`These fields are `,_jsx(_components.strong,{children:`optional enrichment data`}),`. They don’t drive attribution, but they make lead and sale records significantly more useful in analytics and reporting.`]}),`\n`,_jsx(Heading,{level:`3`,id:`customername`,children:_jsx(_components.code,{children:`customerName`})}),`\n`,_jsx(_components.p,{children:`The customer’s full display name.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Property`}),_jsx(_components.th,{children:`Detail`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Source`})}),_jsx(_components.td,{children:`Signup form, profile record, CRM, or auth provider`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Usage`})}),_jsx(_components.td,{children:`Send when you have a reliable, user-facing name available`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`customeremail`,children:_jsx(_components.code,{children:`customerEmail`})}),`\n`,_jsx(_components.p,{children:`The email address associated with the lead or customer.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Property`}),_jsx(_components.th,{children:`Detail`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Source`})}),_jsx(_components.td,{children:`Signup form, login flow, or profile record`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Usage`})}),_jsx(_components.td,{children:`Include when available to improve identity matching and reporting quality`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`quick-reference`,children:`Quick Reference`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Used In`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`clickId`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`string`})}),_jsx(_components.td,{children:`Recommended`}),_jsx(_components.td,{children:`Leads, Sales`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`customerExternalId`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`string`})}),_jsx(_components.td,{children:`Recommended`}),_jsx(_components.td,{children:`Leads, Sales`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`eventName`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`string`})}),_jsx(_components.td,{children:`Required`}),_jsx(_components.td,{children:`Leads, Sales`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`mode`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`string`})}),_jsx(_components.td,{children:`Conditional`}),_jsx(_components.td,{children:`Leads (deferred)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`amount`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`number`})}),_jsx(_components.td,{children:`Required`}),_jsx(_components.td,{children:`Sales`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`currency`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`string`})}),_jsx(_components.td,{children:`Required`}),_jsx(_components.td,{children:`Sales`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`invoiceId`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`string`})}),_jsx(_components.td,{children:`Recommended`}),_jsx(_components.td,{children:`Sales`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`customerName`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`string`})}),_jsx(_components.td,{children:`Optional`}),_jsx(_components.td,{children:`Leads, Sales`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`customerEmail`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`string`})}),_jsx(_components.td,{children:`Optional`}),_jsx(_components.td,{children:`Leads, Sales`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`related-docs`,children:`Related Docs`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/api-reference/endpoint/Lead`,children:`Lead Track`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/api-reference/endpoint/Sale`,children:`Sale Track`})}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Field Reference","description":"Complete reference for attribution, conversion, and user detail fields used in lead and sale tracking.","href":"/api-reference/endpoint/field"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Attribution Fields","slug":"attribution-fields","depth":2,"children":[{"title":"clickId","slug":"clickid","depth":3,"children":[]},{"title":"customerExternalId","slug":"customerexternalid","depth":3,"children":[]},{"title":"eventName","slug":"eventname","depth":3,"children":[]},{"title":"mode","slug":"mode","depth":3,"children":[]}]},{"title":"Conversion Fields","slug":"conversion-fields","depth":2,"children":[{"title":"amount","slug":"amount","depth":3,"children":[]},{"title":"currency","slug":"currency","depth":3,"children":[]},{"title":"invoiceId","slug":"invoiceid","depth":3,"children":[]}]},{"title":"User Detail Fields","slug":"user-detail-fields","depth":2,"children":[{"title":"customerName","slug":"customername","depth":3,"children":[]},{"title":"customerEmail","slug":"customeremail","depth":3,"children":[]}]},{"title":"Quick Reference","slug":"quick-reference","depth":2,"children":[]},{"title":"Related Docs","slug":"related-docs","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"cutmeshort","siteName":"CutMe Short","title":"Field Reference - CutMe Short","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-21T14:19:35.848Z","originalFileLocation":"api-reference/endpoint/field.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"Complete reference for attribution, conversion, and user detail fields used in lead and sale tracking.\">\u003cmeta data-mint-head name=\"application-name\" content=\"CutMe Short\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cutmeshort/-3qNYGRwpXQgss-8/_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/cutmeshort/-3qNYGRwpXQgss-8/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cutmeshort/-3qNYGRwpXQgss-8/_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/cutmeshort/-3qNYGRwpXQgss-8/_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/cutmeshort/-3qNYGRwpXQgss-8/_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/cutmeshort/-3qNYGRwpXQgss-8/_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/cutmeshort/-3qNYGRwpXQgss-8/_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/cutmeshort/-3qNYGRwpXQgss-8/_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/cutmeshort/-3qNYGRwpXQgss-8/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Field Reference - CutMe Short\">\u003cmeta data-mint-head property=\"og:description\" content=\"Complete reference for attribution, conversion, and user detail fields used in lead and sale tracking.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"CutMe Short\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cutmeshort.com/api-reference/endpoint/field\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cutmeshort.mintlify.site/_mintlify/api/og/v2?division=Attribution\u0026amp;title=Field+Reference\u0026amp;description=Complete+reference+for+attribution%2C+conversion%2C+and+user+detail+fields+used+in+lead+and+sale+tracking.\u0026amp;theme=888db68a544cbe3e1ba816f2\u0026amp;signature=8a936e4c761ad90516c820148cb534a772bccd5d6b0529e910070277429d852c\">\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=\"Field Reference - CutMe Short\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Complete reference for attribution, conversion, and user detail fields used in lead and sale tracking.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cutmeshort.mintlify.site/_mintlify/api/og/v2?division=Attribution\u0026amp;title=Field+Reference\u0026amp;description=Complete+reference+for+attribution%2C+conversion%2C+and+user+detail+fields+used+in+lead+and+sale+tracking.\u0026amp;theme=888db68a544cbe3e1ba816f2\u0026amp;signature=8a936e4c761ad90516c820148cb534a772bccd5d6b0529e910070277429d852c\">\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/cutmeshort/-3qNYGRwpXQgss-8/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"CutMe Short\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#602fd2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cutmeshort.com/api-reference/endpoint/field\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/field.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cutmeshort.com/#organization\",\"name\":\"CutMe Short\",\"url\":\"https://docs.cutmeshort.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cutmeshort/DjXa7XIcYuaTMlzC/logo/cms.svg?fit=max\u0026auto=format\u0026n=DjXa7XIcYuaTMlzC\u0026q=85\u0026s=66a6213599d5bb3fc1a233f9ac11345b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cutmeshort.com#website\",\"name\":\"CutMe Short\",\"url\":\"https://docs.cutmeshort.com\",\"publisher\":{\"@id\":\"https://docs.cutmeshort.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cutmeshort.com/api-reference/endpoint/field#webpage\",\"url\":\"https://docs.cutmeshort.com/api-reference/endpoint/field\",\"name\":\"Field Reference\",\"description\":\"Complete reference for attribution, conversion, and user detail fields used in lead and sale tracking.\",\"dateModified\":\"2026-04-21T14:19:35.848Z\",\"isPartOf\":{\"@id\":\"https://docs.cutmeshort.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cutmeshort.com/api-reference/endpoint/field#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cutmeshort.com/api-reference/endpoint/field#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"CutMe Short\",\"item\":\"https://docs.cutmeshort.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Field Reference\",\"item\":\"https://docs.cutmeshort.com/api-reference/endpoint/field\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.cutmeshort.com/api-reference/endpoint/field#article\",\"headline\":\"Field Reference\",\"name\":\"Field Reference\",\"description\":\"Complete reference for attribution, conversion, and user detail fields used in lead and sale tracking.\",\"url\":\"https://docs.cutmeshort.com/api-reference/endpoint/field\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cutmeshort.com/api-reference/endpoint/field#webpage\"},\"dateModified\":\"2026-04-21T14:19:35.848Z\",\"publisher\":{\"@id\":\"https://docs.cutmeshort.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cutmeshort.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"CutMe Short\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"CutMe Short","nav":{"global":null,"tabs":[{"tab":"Features","icon":"book-open","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Quickstart","href":"/quickstart"}]},{"group":"Features","pages":[{"title":"Link Attribution","icon":"chart-line","href":"/features/LeadSaleTrackAttribution"},{"title":"Custom Domain","icon":"globe-pointer","href":"/features/CustomDomain"},{"title":"Custom QR codes","icon":"qrcode","href":"/features/CustomQR"},{"title":"Social Previews","icon":"image","href":"/features/SocialPreviews"},{"title":"Advance Analytics","icon":"chart-simple","href":"/features/AdvanceAnalytics"}]},{"group":"SDKs","pages":[{"title":"Overview","href":"/sdks/overview"},{"group":"Client-side","pages":[{"title":"Introduction","href":"/sdks/clientside/introduction"},{"group":"Installation guide","pages":[{"title":"Manual Installation","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cutmeshort/images/Attribution/manualinstallation.png","href":"/sdks/clientside/manualinstallation"}]}]},{"group":"Server-side","pages":[{"title":"Python SDK","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cutmeshort/images/Attribution/pylogo.png","href":"/sdks/serverside/pythonSDK"},{"title":"TypeScript SDK","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cutmeshort/images/Attribution/tslogo.svg","href":"/sdks/serverside/typescriptSDK"},{"title":"PHP SDK","description":"Official PHP SDK for CutMeShort API","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cutmeshort/images/Attribution/php.png","href":"/sdks/serverside/phpSDK"}]}]},{"group":"Attribution","pages":[{"title":"Field Reference","href":"/api-reference/endpoint/field"},{"title":"First-Click vs Last-Click","description":"Understand how cms_rf cookie attribution works, the difference between first-click and last-click models, and which one is right for your tracking strategy.","href":"/api-reference/endpoint/clickattribution"},{"title":"Lead Track","href":"/api-reference/endpoint/Lead"},{"title":"Sale Track","href":"/api-reference/endpoint/Sale"}]}]},{"tab":"API Docs","icon":"square-terminal","pages":[{"title":"API Docs","href":"/api-reference/introduction"}]}]},"basePath":"","title":"Field Reference - CutMe Short","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":[],"chunks":[]}
