The machine-readable key. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Generated from the name when omitted.
Expose this field's values in the Spotter API response. Off by default: exposed values become readable on your website by any script that can access the Spotter response.
Whether this field's values are exposed in the Spotter API response
Example:
false
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Snitcher Documentation","colors":{"primary":"#4133F5","light":"#7153FF","dark":"#4133F5"},"logo":{"light":"https://mintcdn.com/snitcher/iDUcVKoxR9vkXPyl/logo/light.svg?fit=max\u0026auto=format\u0026n=iDUcVKoxR9vkXPyl\u0026q=85\u0026s=f11299c55a62dee99a560a31dac08444","dark":"https://mintcdn.com/snitcher/iDUcVKoxR9vkXPyl/logo/dark.svg?fit=max\u0026auto=format\u0026n=iDUcVKoxR9vkXPyl\u0026q=85\u0026s=a66c9968f418736f2c3614d33b101b3f","href":"https://snitcher.com"},"favicon":"https://mintcdn.com/snitcher/iDUcVKoxR9vkXPyl/favicon.svg?fit=max\u0026auto=format\u0026n=iDUcVKoxR9vkXPyl\u0026q=85\u0026s=7546903aa0cdd4dfa97eae244d0e1e7c","navbar":{"links":[],"primary":{"type":"button","label":"Dashboard","href":"https://app.snitcher.com"}},"footer":{"socials":{"website":"https://snitcher.com","linkedin":"https://linkedin.com/company/snitcher"}},"seo":{"metatags":{"og:site_name":"Snitcher Documentation","og:type":"website","twitter:card":"summary_large_image"}},"integrations":{"intercom":{"appId":"wxz81st3"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Help Center","icon":"book-open-cover","href":"https://help.snitcher.com/en/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"snitcher","hasAudioNarration":false,"actualSubdomain":"snitcher","customDomains":["docs.snitcher.com"],"gitSource":{"type":"github","owner":"snitcher","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad235740f6013e3b515e7c3","collectionId":"8f132daa-72b8-448d-b5b7-37f6a8cfa366","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad235740f6013e3b515e7c3"},"feedback":{"edits":true,"issues":true},"entitlements":{},"buildId":"6ad235740f6013e3b515e7c3","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Platform","count":66},{"language":"default","tag":"Documentation","count":44},{"language":"default","tag":"API Reference","count":44},{"language":"default","tag":"Radar","count":21},{"language":"default","tag":"Integrations","count":16},{"language":"default","tag":"Workspaces","count":10},{"language":"default","tag":"Get Started","count":8},{"language":"default","tag":"Tracker","count":8},{"language":"default","tag":"Tracking scripts","count":8},{"language":"default","tag":"CRM","count":7}]},"assistantConfig":{},"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":"editor-v7-file-tree","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":"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/custom-fields/create-a-custom-field-definition","slug":"/api-reference/custom-fields/create-a-custom-field-definition","pageMetadata":{"title":"Create a custom field definition","description":null,"deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json post /v1/workspaces/{workspaceUuid}/custom-fields","href":"/api-reference/custom-fields/create-a-custom-field-definition","autogeneratedByOpenApi":true},"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":"Create a custom field definition","description":null,"deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json post /v1/workspaces/{workspaceUuid}/custom-fields","href":"/api-reference/custom-fields/create-a-custom-field-definition","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/snitcher/71c94d7889a42bed/utils.js"],"openApiReferenceData":{"operation":{"tags":["Custom Fields"],"summary":"Create a custom field definition","operationId":"3f6fbac40b703a6d7c2613057f22415a","parameters":["b58ec556-6b80-4066-b972-7481cd110286"],"requestBody":"4bf12a98-eb78-4391-a0a9-54f9abcc1325","responses":{"201":"919ddcf2-acb2-445f-8a1f-c6302b4b155e"},"security":["255834d0-2db6-4187-b639-e411dd320c17"],"method":"post","type":"path","servers":["53df448f-cfa3-4679-9b49-b09404eba60a"],"path":"/v1/workspaces/{workspaceUuid}/custom-fields","baseUrlOptions":["https://api.snitcher.com"],"title":"Create a custom field definition","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b58ec556-6b80-4066-b972-7481cd110286":{"name":"workspaceUuid","in":"path","description":"The UUID of the workspace","required":true,"schema":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"description":"The UUID of the workspace","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Store Custom Field Request","description":"Request body for creating a custom field definition","required":["name","type"],"properties":{"name":{"description":"The human-readable name of the field","type":"string","maxLength":255,"example":"Industry","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"type":{"description":"The data type of the field","type":"string","example":"text","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"key":{"oneOf":[{"description":"The machine-readable key. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Generated from the name when omitted.","type":"string","maxLength":255,"example":"industry","uniqueKey":"key.oneOf.0","typeLabel":"string"},{"description":"The machine-readable key. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Generated from the name when omitted.","type":"null","maxLength":255,"example":"industry","uniqueKey":"key.oneOf.1","typeLabel":"null"}],"uniqueKey":"key","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","maxLength":1000,"example":"The primary industry of the company.","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":1000,"example":"The primary industry of the company.","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"visible_in_spotter":{"oneOf":[{"description":"Expose this field's values in the Spotter API response. Off by default: exposed values become readable on your website by any script that can access the Spotter response.","type":"boolean","example":false,"uniqueKey":"visible_in_spotter.oneOf.0","typeLabel":"boolean"},{"description":"Expose this field's values in the Spotter API response. Off by default: exposed values become readable on your website by any script that can access the Spotter response.","type":"null","example":false,"uniqueKey":"visible_in_spotter.oneOf.1","typeLabel":"null"}],"uniqueKey":"visible_in_spotter","typeLabel":"boolean | null"},"field_rules":{"oneOf":[{"type":"array","items":{"required":["type"],"properties":{"type":{"description":"The rule type","type":"string","isRequired":true,"uniqueKey":"field_rules.oneOf.0.items.[INDEX].type","typeLabel":"string"},"config":{"oneOf":[{"type":"object","uniqueKey":"field_rules.oneOf.0.items.[INDEX].config.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"field_rules.oneOf.0.items.[INDEX].config.oneOf.1","typeLabel":"null"}],"uniqueKey":"field_rules.oneOf.0.items.[INDEX].config","typeLabel":"object | null"}},"type":"object","uniqueKey":"field_rules.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"field_rules.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"required":["type"],"properties":{"type":{"description":"The rule type","type":"string"},"config":{"oneOf":[{"type":"object"},{"type":"null"}]}},"type":"object"},"uniqueKey":"field_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"field_rules","typeLabel":"object[] | null"},"options":{"oneOf":[{"type":"array","items":{"required":["key","label"],"properties":{"key":{"type":"string","maxLength":255,"example":"technology","isRequired":true,"uniqueKey":"options.oneOf.0.items.[INDEX].key","typeLabel":"string"},"label":{"type":"string","maxLength":255,"example":"Technology","isRequired":true,"uniqueKey":"options.oneOf.0.items.[INDEX].label","typeLabel":"string"},"color":{"oneOf":[{"type":"string","maxLength":50,"example":"#FF0000","uniqueKey":"options.oneOf.0.items.[INDEX].color.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":50,"example":"#FF0000","uniqueKey":"options.oneOf.0.items.[INDEX].color.oneOf.1","typeLabel":"null"}],"uniqueKey":"options.oneOf.0.items.[INDEX].color","typeLabel":"string | null"}},"type":"object","uniqueKey":"options.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"options.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"required":["key","label"],"properties":{"key":{"type":"string","maxLength":255,"example":"technology"},"label":{"type":"string","maxLength":255,"example":"Technology"},"color":{"oneOf":[{"type":"string","maxLength":50,"example":"#FF0000"},{"type":"null","maxLength":50,"example":"#FF0000"}]}},"type":"object"},"uniqueKey":"options.oneOf.1","typeLabel":"null"}],"uniqueKey":"options","typeLabel":"object[] | null"}},"type":"object","uniqueKey":"","typeLabel":"Store Custom Field Request · object"},"examples":{"Example":{"title":"Example","value":{"name":"Industry","type":"text","key":"industry","description":"The primary industry of the company.","visible_in_spotter":false,"field_rules":[{"type":"\u003cstring>","config":{}}],"options":[{"key":"technology","label":"Technology","color":"#FF0000"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"919ddcf2-acb2-445f-8a1f-c6302b4b155e":{"description":"The created custom field definition","content":{"application/json":{"schema":{"title":"Custom Field","description":"A custom field definition for organisations","properties":{"identifier":{"description":"The unique identifier of the field","type":"string","example":"industry","uniqueKey":"identifier","typeLabel":"string"},"key":{"description":"The machine-readable key of the field","type":"string","example":"industry","uniqueKey":"key","typeLabel":"string"},"name":{"description":"The human-readable name of the field","type":"string","example":"Industry","uniqueKey":"name","typeLabel":"string"},"entity_type":{"description":"The entity type the field belongs to","type":"string","example":"organisation","uniqueKey":"entity_type","typeLabel":"string"},"type":{"description":"The data type of the field","type":"string","example":"text","uniqueKey":"type","typeLabel":"string"},"description":{"oneOf":[{"type":"string","example":"The primary industry of the company.","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","example":"The primary industry of the company.","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"group":{"description":"The group the field belongs to","type":"string","example":"custom","uniqueKey":"group","typeLabel":"string"},"is_visible":{"type":"boolean","example":true,"uniqueKey":"is_visible","typeLabel":"boolean"},"source":{"description":"The source of the field","type":"string","example":"manual","uniqueKey":"source","typeLabel":"string"},"rules":{"type":"array","items":{"type":"object","uniqueKey":"rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"rules","typeLabel":"object[]"},"is_system":{"type":"boolean","example":false,"uniqueKey":"is_system","typeLabel":"boolean"},"options":{"type":"array","items":{"type":"object","uniqueKey":"options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"options","typeLabel":"object[]"},"visible_in_spotter":{"description":"Whether this field's values are exposed in the Spotter API response","type":"boolean","example":false,"uniqueKey":"visible_in_spotter","typeLabel":"boolean"}},"type":"object","uniqueKey":"","typeLabel":"Custom Field · object"},"examples":{"Example":{"title":"Example","value":{"identifier":"industry","key":"industry","name":"Industry","entity_type":"organisation","type":"text","description":"The primary industry of the company.","group":"custom","is_visible":true,"source":"manual","rules":[{}],"is_system":false,"options":[{}],"visible_in_spotter":false}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"255834d0-2db6-4187-b639-e411dd320c17":{"Snitcher bearer token":{"type":"http","description":"Enter your personal access token (PAT) to authenticate","bearerFormat":"JWT","scheme":"bearer","scopes":[]}}},"servers":{"53df448f-cfa3-4679-9b49-b09404eba60a":{"url":"https://api.snitcher.com","description":"Production API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Enter your personal access token (PAT) to authenticate","bearerFormat":"JWT","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Enter your personal access token (PAT) to authenticate","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Snitcher bearer token","name":"Authorization"}],"title":"Snitcher bearer token"}]},"originalFileLocation":"https://app.snitcher.com/api/docs?api-docs.json"},"subdomain":"snitcher","siteName":"Snitcher Documentation","title":"Create a custom field definition - Snitcher Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-16T14:32:25.507Z","originalFileLocation":"api-reference/custom-fields/create-a-custom-field-definition.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=\"application-name\" content=\"Snitcher Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/snitcher/-5JobTDnc_TkmyNK/_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/snitcher/-5JobTDnc_TkmyNK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/snitcher/-5JobTDnc_TkmyNK/_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/snitcher/-5JobTDnc_TkmyNK/_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/snitcher/-5JobTDnc_TkmyNK/_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/snitcher/-5JobTDnc_TkmyNK/_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/snitcher/-5JobTDnc_TkmyNK/_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/snitcher/-5JobTDnc_TkmyNK/_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/snitcher/-5JobTDnc_TkmyNK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a custom field definition - Snitcher Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Snitcher Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.snitcher.com/api-reference/custom-fields/create-a-custom-field-definition\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://snitcher.mintlify.app/_mintlify/api/og/v2?division=Custom+Fields\u0026amp;title=Create+a+custom+field+definition\u0026amp;theme=6a39893ee631aa292a456321\u0026amp;signature=46971a4594e967f083c5c0729359d508d005b79726c68376e287e4fcd243ae4d\">\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=\"Create a custom field definition - Snitcher Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://snitcher.mintlify.app/_mintlify/api/og/v2?division=Custom+Fields\u0026amp;title=Create+a+custom+field+definition\u0026amp;theme=6a39893ee631aa292a456321\u0026amp;signature=46971a4594e967f083c5c0729359d508d005b79726c68376e287e4fcd243ae4d\">\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/snitcher/-5JobTDnc_TkmyNK/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Snitcher Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4133F5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.snitcher.com/api-reference/custom-fields/create-a-custom-field-definition\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/custom-fields/create-a-custom-field-definition.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.snitcher.com/#organization\",\"name\":\"Snitcher Documentation\",\"url\":\"https://docs.snitcher.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/snitcher/iDUcVKoxR9vkXPyl/logo/light.svg?fit=max\u0026auto=format\u0026n=iDUcVKoxR9vkXPyl\u0026q=85\u0026s=f11299c55a62dee99a560a31dac08444\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.snitcher.com#website\",\"name\":\"Snitcher Documentation\",\"url\":\"https://docs.snitcher.com\",\"publisher\":{\"@id\":\"https://docs.snitcher.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.snitcher.com/api-reference/custom-fields/create-a-custom-field-definition#webpage\",\"url\":\"https://docs.snitcher.com/api-reference/custom-fields/create-a-custom-field-definition\",\"name\":\"Create a custom field definition\",\"dateModified\":\"2026-10-16T14:32:25.507Z\",\"isPartOf\":{\"@id\":\"https://docs.snitcher.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.snitcher.com/api-reference/custom-fields/create-a-custom-field-definition#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.snitcher.com/api-reference/custom-fields/create-a-custom-field-definition#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Custom Fields\",\"item\":\"https://docs.snitcher.com/api-reference/custom-fields/list-custom-field-definitions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a custom field definition\",\"item\":\"https://docs.snitcher.com/api-reference/custom-fields/create-a-custom-field-definition\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.snitcher.com/api-reference/custom-fields/create-a-custom-field-definition#apireference\",\"headline\":\"Create a custom field definition\",\"name\":\"Create a custom field definition\",\"url\":\"https://docs.snitcher.com/api-reference/custom-fields/create-a-custom-field-definition\",\"mainEntityOfPage\":{\"@id\":\"https://docs.snitcher.com/api-reference/custom-fields/create-a-custom-field-definition#webpage\"},\"dateModified\":\"2026-10-16T14:32:25.507Z\",\"publisher\":{\"@id\":\"https://docs.snitcher.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.snitcher.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Snitcher Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Snitcher Documentation","nav":{"global":{"anchors":[{"anchor":"Help Center","icon":"book-open-cover","href":"https://help.snitcher.com/en/"}]},"products":[{"product":"Platform","icon":"grid-2","description":"Website visitor identification for sales and marketing teams","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/product/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"REST API Introduction","href":"/product/rest-api/introduction"}]},{"group":"Workspaces","pages":[{"title":"Get the workspace's contact reveal credit balance","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json get /v1/workspaces/{workspaceUuid}/contact-credits","href":"/api-reference/workspaces/get-the-workspaces-contact-reveal-credit-balance"},{"title":"Get the workspace's tracker features","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json get /v1/workspaces/{workspaceUuid}/tracker-features","href":"/api-reference/workspaces/get-the-workspaces-tracker-features"},{"title":"Update the workspace's tracker features","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json patch /v1/workspaces/{workspaceUuid}/tracker-features","href":"/api-reference/workspaces/update-the-workspaces-tracker-features"},{"title":"Get the user's workspaces","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json get /v1/workspaces","href":"/api-reference/workspaces/get-the-users-workspaces"},{"title":"Create a new workspace","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json post /v1/workspaces","href":"/api-reference/workspaces/create-a-new-workspace"},{"title":"Get details of a specific workspace","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json get /v1/workspaces/{uuid}","href":"/api-reference/workspaces/get-details-of-a-specific-workspace"},{"title":"Delete a workspace","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json delete /v1/workspaces/{uuid}","href":"/api-reference/workspaces/delete-a-workspace"},{"title":"Update workspace details","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json patch /v1/workspaces/{uuid}","href":"/api-reference/workspaces/update-workspace-details"},{"title":"Invite a user to a workspace","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json post /v1/workspaces/{uuid}/users/invite","href":"/api-reference/workspaces/invite-a-user-to-a-workspace"},{"title":"Create a new tag for a workspace","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json post /v1/workspaces/{uuid}/tags","href":"/api-reference/workspaces/create-a-new-tag-for-a-workspace"}]},{"group":"Custom Fields","pages":[{"title":"List custom field definitions","description":null,"deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json get /v1/workspaces/{workspaceUuid}/custom-fields","href":"/api-reference/custom-fields/list-custom-field-definitions"},{"title":"Create a custom field definition","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json post /v1/workspaces/{workspaceUuid}/custom-fields","href":"/api-reference/custom-fields/create-a-custom-field-definition"},{"title":"Get a custom field definition","description":null,"deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json get /v1/workspaces/{workspaceUuid}/custom-fields/{key}","href":"/api-reference/custom-fields/get-a-custom-field-definition"},{"title":"Delete a custom field definition","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json delete /v1/workspaces/{workspaceUuid}/custom-fields/{key}","href":"/api-reference/custom-fields/delete-a-custom-field-definition"},{"title":"Update a custom field definition","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json patch /v1/workspaces/{workspaceUuid}/custom-fields/{key}","href":"/api-reference/custom-fields/update-a-custom-field-definition"}]},{"group":"Contacts","pages":[{"title":"Get contacts for an organisation","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json get /v1/workspaces/{workspaceUuid}/contacts","href":"/api-reference/contacts/get-contacts-for-an-organisation"},{"title":"Reveal an email for an organisation contact","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json put /v1/workspaces/{workspaceUuid}/contacts/{contactUuid}/reveal-email","href":"/api-reference/contacts/reveal-an-email-for-an-organisation-contact"}]},{"group":"Organisations","pages":[{"title":"List organisations","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json get /v1/workspaces/{workspaceUuid}/organisations","href":"/api-reference/organisations/list-organisations"},{"title":"List organisations using advanced filters","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json post /v1/workspaces/{workspaceUuid}/organisations","href":"/api-reference/organisations/list-organisations-using-advanced-filters"},{"title":"Get an organisation","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json get /v1/workspaces/{workspaceUuid}/organisations/{organisationUuid}","href":"/api-reference/organisations/get-an-organisation"},{"title":"Add a tag to an organisation","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json post /v1/workspaces/{workspaceUuid}/organisations/{organisationUuid}/tags","href":"/api-reference/organisations/add-a-tag-to-an-organisation"},{"title":"Remove a tag from an organisation","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json delete /v1/workspaces/{workspaceUuid}/organisations/{organisationUuid}/tags","href":"/api-reference/organisations/remove-a-tag-from-an-organisation"}]},{"group":"Custom Field Values","pages":[{"title":"List custom field values for an organisation","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json get /v1/workspaces/{workspaceUuid}/organisations/{organisationUuid}/custom-fields","href":"/api-reference/custom-field-values/list-custom-field-values-for-an-organisation"},{"title":"Set multiple custom field values on an organisation","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json patch /v1/workspaces/{workspaceUuid}/organisations/{organisationUuid}/custom-fields","href":"/api-reference/custom-field-values/set-multiple-custom-field-values-on-an-organisation"},{"title":"Set a custom field value on an organisation","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json put /v1/workspaces/{workspaceUuid}/organisations/{organisationUuid}/custom-fields/{key}","href":"/api-reference/custom-field-values/set-a-custom-field-value-on-an-organisation"},{"title":"Clear a custom field value on an organisation","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json delete /v1/workspaces/{workspaceUuid}/organisations/{organisationUuid}/custom-fields/{key}","href":"/api-reference/custom-field-values/clear-a-custom-field-value-on-an-organisation"}]},{"group":"Segments","pages":[{"title":"List all segments in a workspace","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json get /v1/workspaces/{workspaceUuid}/segments","href":"/api-reference/segments/list-all-segments-in-a-workspace"}]},{"group":"Sessions","pages":[{"title":"Overview of the sessions in a date range","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json get /v1/workspaces/{workspaceUuid}/sessions","href":"/api-reference/sessions/overview-of-the-sessions-in-a-date-range"},{"title":"Overview of the sessions of an organisation","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json get /v1/workspaces/{workspaceUuid}/organisations/{organisationUuid}/sessions","href":"/api-reference/sessions/overview-of-the-sessions-of-an-organisation"}]},{"group":"User","pages":[{"title":"Get the authenticated user's profile","deprecated":null,"version":null,"openapi":"https://app.snitcher.com/api/docs?api-docs.json get /v1/me","href":"/api-reference/user/get-the-authenticated-users-profile"}]}]},{"tab":"Reference","pages":[{"title":"Reference","href":"/reference/filter-fields"}]}]},{"product":"Radar","icon":"radar","description":"White-label visitor identification for your product","pages":[{"title":"Radar","href":"/powered-by-snitcher/radar/introduction"}]},{"product":"IP to Company","icon":"server","description":"Real-time company lookup from IP addresses","pages":[{"title":"IP to Company","href":"/powered-by-snitcher/ip2company/introduction"}]}]},"title":"Create a custom field definition - Snitcher Documentation","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}