Display name for each field and property source in the contract: the catalog label for a default field, the saved name for a custom field. A source without a name is absent. Presentation only; it is not part of the contract the engine receives.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Weelkit","description":"How to use Weelkit: chat with AI, write and publish articles, manage your images and knowledge, and track how your content performs in search and AI answers.","colors":{"primary":"#161614","light":"#F3EDE9","dark":"#161614"},"logo":{"light":"https://mintcdn.com/weelkit/rCK35laReQLc0j4Z/logo/light.svg?fit=max\u0026auto=format\u0026n=rCK35laReQLc0j4Z\u0026q=85\u0026s=2f851f7771527dd0905713f660f88b0c","dark":"https://mintcdn.com/weelkit/rCK35laReQLc0j4Z/logo/dark.svg?fit=max\u0026auto=format\u0026n=rCK35laReQLc0j4Z\u0026q=85\u0026s=4e20386a2bee6fafeac4d8002ee2319f"},"favicon":"https://mintcdn.com/weelkit/rCK35laReQLc0j4Z/favicon.svg?fit=max\u0026auto=format\u0026n=rCK35laReQLc0j4Z\u0026q=85\u0026s=f1d980f05789b3c4091ecd5ef6373dce","background":{"color":{"light":"#FBFAF8","dark":"#161614"}},"navbar":{"links":[{"href":"mailto:hello@weelkit.com","label":"Support"}]},"contextual":{"options":["copy","view"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"weelkit","hasAudioNarration":false,"actualSubdomain":"weelkit","customDomains":["docs.weelkit.com"],"gitSource":{"type":"github","owner":"weelkit","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad9e473db34909eda594d91","collectionId":"d8b36159-0e6d-4c97-a155-3790a9b51c0c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad9e473db34909eda594d91"},"entitlements":{},"buildId":"6adc33b77008c2a717e741ae","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"Guides","count":25},{"language":"default","tag":"Integrations","count":18},{"language":"default","tag":"API reference","count":17},{"language":"default","tag":"Webhooks","count":8},{"language":"default","tag":"Organization article fields","count":7},{"language":"default","tag":"Get started","count":5},{"language":"default","tag":"Custom API","count":5},{"language":"default","tag":"Publishing overview","count":5},{"language":"default","tag":"Metrics","count":5},{"language":"default","tag":"Settings","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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/article-fields/effective-contract","slug":"/api-reference/article-fields/effective-contract","pageMetadata":{"title":"Preview the effective contract","openapi":"GET /api/v1/organization/article-fields/effective-contract","description":"Compiles the canonical catalog plus the organization's active custom fields, with the stable schema fingerprint used at generation time.","href":"/api-reference/article-fields/effective-contract"},"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: \"Compiles the canonical catalog plus the organization’s active custom fields, with the stable schema fingerprint used at generation time.\"\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":"Preview the effective contract","openapi":"GET /api/v1/organization/article-fields/effective-contract","description":"Compiles the canonical catalog plus the organization's active custom fields, with the stable schema fingerprint used at generation time.","href":"/api-reference/article-fields/effective-contract"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getEffectiveArticleContract","summary":"Preview the effective article contract","description":"Compiles the canonical catalog plus the organization's active custom fields, with the stable schema fingerprint used at generation time.","parameters":["05cebbf6-9282-481b-aa00-c7c952480cea"],"responses":{"200":"51651260-6da4-4a10-9ebe-aa0819531cd9","401":"efbdffcc-5481-4094-9f8a-8ba45a35a9f0"},"method":"get","type":"path","servers":["74a333ae-afe4-4bdb-8178-d89a41824362"],"security":["d9acb8e2-f57b-4093-816a-8fad7a7d9022"],"path":"/api/v1/organization/article-fields/effective-contract","baseUrlOptions":["https://api.weelkit.com"],"title":"Preview the effective article contract","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"05cebbf6-9282-481b-aa00-c7c952480cea":{"name":"X-Org-Id","in":"header","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"The organization the request acts on.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"The organization the request acts on."}},"responses":{"51651260-6da4-4a10-9ebe-aa0819531cd9":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","required":["schemaFingerprint","organizationFieldRevision","activeOrganizationFieldCount","contract","fieldLabels"],"properties":{"schemaFingerprint":{"type":"string","description":"weelkit-platform-article.v3 for the recommended organization preset, with selection and organization-field suffixes when configured.","isRequired":true,"uniqueKey":"schemaFingerprint","typeLabel":"string"},"organizationFieldRevision":{"type":"integer","isRequired":true,"uniqueKey":"organizationFieldRevision","typeLabel":"integer"},"activeOrganizationFieldCount":{"type":"integer","isRequired":true,"uniqueKey":"activeOrganizationFieldCount","typeLabel":"integer"},"contract":{"type":"object","required":["contractVersion","canonicalCatalogVersion","providerSlug","contentTypeId","fields"],"properties":{"contractVersion":{"type":"integer","isRequired":true,"uniqueKey":"contract.contractVersion","typeLabel":"integer"},"canonicalCatalogVersion":{"type":"integer","isRequired":true,"uniqueKey":"contract.canonicalCatalogVersion","typeLabel":"integer"},"providerSlug":{"type":"string","isRequired":true,"uniqueKey":"contract.providerSlug","typeLabel":"string"},"contentTypeId":{"type":"string","isRequired":true,"uniqueKey":"contract.contentTypeId","typeLabel":"string"},"fields":{"type":"array","items":{"type":"object","description":"One field of the canonical article output contract, exactly as serialized by the API.","required":["source","outputPath","type","normalizedType","shape","required","description","instruction","allowedOptions","defaultValue","referenceTarget","referenceSelectionPolicy","defaultReferenceOptionId","generationOwner","children","bindings"],"properties":{"source":{"type":"string","isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].source","typeLabel":"string"},"outputPath":{"type":"string","isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].outputPath","typeLabel":"string"},"type":{"type":"string","isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].type","typeLabel":"string"},"normalizedType":{"type":"string","isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].normalizedType","typeLabel":"string"},"shape":{"description":"Structural shape metadata; null for flat fields.","isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].shape","typeLabel":"any"},"required":{"type":"boolean","isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].required","typeLabel":"boolean"},"description":{"type":"string","isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].description","typeLabel":"string"},"instruction":{"type":"string","isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].instruction","typeLabel":"string"},"allowedOptions":{"type":"array","items":{"type":"object","required":["label","value"],"properties":{"label":{"type":"string","maxLength":200,"isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].allowedOptions.items.[INDEX].label","typeLabel":"string"},"value":{"type":"string","maxLength":200,"isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].allowedOptions.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"contract.fields.items.[INDEX].allowedOptions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].allowedOptions","typeLabel":"object[]"},"defaultValue":{"description":"Configured default value; null when absent.","isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].defaultValue","typeLabel":"any"},"referenceTarget":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].referenceTarget.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].referenceTarget.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].referenceTarget","typeLabel":"string | null"},"referenceSelectionPolicy":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].referenceSelectionPolicy.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].referenceSelectionPolicy.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].referenceSelectionPolicy","typeLabel":"string | null"},"defaultReferenceOptionId":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].defaultReferenceOptionId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].defaultReferenceOptionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].defaultReferenceOptionId","typeLabel":"string\u003cuuid> | null"},"generationOwner":{"type":"string","enum":["ai","backend"],"isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].generationOwner","typeLabel":"enum\u003cstring>"},"children":{"type":"array","items":{"$circularRef":"e5e44382-30fb-4914-a800-886f61e0e9f5"},"isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].children","typeLabel":"array"},"bindings":{"type":"array","items":{"description":"Provider binding metadata for schema-backed destinations.","uniqueKey":"contract.fields.items.[INDEX].bindings.items.[INDEX]","typeLabel":"any"},"isRequired":true,"uniqueKey":"contract.fields.items.[INDEX].bindings","typeLabel":"any[]"}},"uniqueKey":"contract.fields.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"contract.fields","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"contract","typeLabel":"object"},"fieldLabels":{"type":"object","description":"Display name for each field and property source in the contract: the catalog label for a default field, the saved name for a custom field. A source without a name is absent. Presentation only; it is not part of the contract the engine receives.","additionalProperties":{"type":"string","uniqueKey":"fieldLabels.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"fieldLabels","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"schemaFingerprint":"\u003cstring>","organizationFieldRevision":123,"activeOrganizationFieldCount":123,"contract":{"contractVersion":123,"canonicalCatalogVersion":123,"providerSlug":"\u003cstring>","contentTypeId":"\u003cstring>","fields":[{"source":"\u003cstring>","outputPath":"\u003cstring>","type":"\u003cstring>","normalizedType":"\u003cstring>","shape":"\u003cunknown>","required":true,"description":"\u003cstring>","instruction":"\u003cstring>","allowedOptions":[{"label":"\u003cstring>","value":"\u003cstring>"}],"defaultValue":"\u003cunknown>","referenceTarget":"\u003cstring>","referenceSelectionPolicy":"\u003cstring>","defaultReferenceOptionId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","generationOwner":"ai","children":"\u003carray>","bindings":["\u003cunknown>"]}]},"fieldLabels":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"efbdffcc-5481-4094-9f8a-8ba45a35a9f0":{"description":"Missing or invalid authentication, or no organization context.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable error code, e.g. Validation, Conflict, NotFound, Forbidden.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errors":{"oneOf":[{"type":"array","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"errors.oneOf.0.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.oneOf.0.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string"},"message":{"type":"string"}}},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object[] | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","errors":[{"field":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"d9acb8e2-f57b-4093-816a-8fad7a7d9022":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Weelkit access token.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"74a333ae-afe4-4bdb-8178-d89a41824362":{"url":"https://api.weelkit.com"}},"schemas":{"e5e44382-30fb-4914-a800-886f61e0e9f5":{"type":"object","description":"One field of the canonical article output contract, exactly as serialized by the API.","required":["source","outputPath","type","normalizedType","shape","required","description","instruction","allowedOptions","defaultValue","referenceTarget","referenceSelectionPolicy","defaultReferenceOptionId","generationOwner","children","bindings"],"properties":{"source":{"type":"string","isRequired":true},"outputPath":{"type":"string","isRequired":true},"type":{"type":"string","isRequired":true},"normalizedType":{"type":"string","isRequired":true},"shape":{"description":"Structural shape metadata; null for flat fields.","isRequired":true},"required":{"type":"boolean","isRequired":true},"description":{"type":"string","isRequired":true},"instruction":{"type":"string","isRequired":true},"allowedOptions":{"type":"array","items":{"type":"object","required":["label","value"],"properties":{"label":{"type":"string","maxLength":200,"isRequired":true},"value":{"type":"string","maxLength":200,"isRequired":true}}},"isRequired":true},"defaultValue":{"description":"Configured default value; null when absent.","isRequired":true},"referenceTarget":{"oneOf":[{"type":"string","isRequired":true},{"type":"null","isRequired":true}],"isRequired":true},"referenceSelectionPolicy":{"oneOf":[{"type":"string","isRequired":true},{"type":"null","isRequired":true}],"isRequired":true},"defaultReferenceOptionId":{"oneOf":[{"type":"string","format":"uuid","isRequired":true},{"type":"null","format":"uuid","isRequired":true}],"isRequired":true},"generationOwner":{"type":"string","enum":["ai","backend"],"isRequired":true},"children":{"type":"array","items":{"$circularRef":"e5e44382-30fb-4914-a800-886f61e0e9f5"},"isRequired":true},"bindings":{"type":"array","items":{"description":"Provider binding metadata for schema-backed destinations."},"isRequired":true}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Weelkit access token.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Weelkit access token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"weelkit","siteName":"Weelkit","title":"Preview the effective contract - Weelkit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-03T14:56:01.394Z","originalFileLocation":"api-reference/article-fields/effective-contract.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=\"Compiles the canonical catalog plus the organization\u0026#x27;s active custom fields, with the stable schema fingerprint used at generation time.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Weelkit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/weelkit/Oct13_C6s-hSAC4M/_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/weelkit/Oct13_C6s-hSAC4M/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/weelkit/Oct13_C6s-hSAC4M/_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/weelkit/Oct13_C6s-hSAC4M/_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/weelkit/Oct13_C6s-hSAC4M/_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/weelkit/Oct13_C6s-hSAC4M/_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/weelkit/Oct13_C6s-hSAC4M/_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/weelkit/Oct13_C6s-hSAC4M/_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/weelkit/Oct13_C6s-hSAC4M/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Preview the effective contract - Weelkit\">\u003cmeta data-mint-head property=\"og:description\" content=\"Compiles the canonical catalog plus the organization\u0026#x27;s active custom fields, with the stable schema fingerprint used at generation time.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Weelkit\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.weelkit.com/api-reference/article-fields/effective-contract\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://weelkit.mintlify.app/_mintlify/api/og/v2?division=Organization+article+fields\u0026amp;title=Preview+the+effective+contract\u0026amp;description=Compiles+the+canonical+catalog+plus+the+organization%27s+active+custom+fields%2C+with+the+stable+schema+fingerprint+used+at+generation+time.\u0026amp;theme=f091cb919715f97f6b8fbb0a\u0026amp;signature=3084091ae5be374f388f9e22f46135643858c149226a9db0b847f78a57395188\">\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=\"Preview the effective contract - Weelkit\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Compiles the canonical catalog plus the organization\u0026#x27;s active custom fields, with the stable schema fingerprint used at generation time.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://weelkit.mintlify.app/_mintlify/api/og/v2?division=Organization+article+fields\u0026amp;title=Preview+the+effective+contract\u0026amp;description=Compiles+the+canonical+catalog+plus+the+organization%27s+active+custom+fields%2C+with+the+stable+schema+fingerprint+used+at+generation+time.\u0026amp;theme=f091cb919715f97f6b8fbb0a\u0026amp;signature=3084091ae5be374f388f9e22f46135643858c149226a9db0b847f78a57395188\">\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/weelkit/Oct13_C6s-hSAC4M/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Weelkit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#161614\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.weelkit.com/api-reference/article-fields/effective-contract\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/article-fields/effective-contract.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.weelkit.com/#organization\",\"name\":\"Weelkit\",\"url\":\"https://docs.weelkit.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/weelkit/rCK35laReQLc0j4Z/logo/light.svg?fit=max\u0026auto=format\u0026n=rCK35laReQLc0j4Z\u0026q=85\u0026s=2f851f7771527dd0905713f660f88b0c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.weelkit.com#website\",\"name\":\"Weelkit\",\"url\":\"https://docs.weelkit.com\",\"publisher\":{\"@id\":\"https://docs.weelkit.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.weelkit.com/api-reference/article-fields/effective-contract#webpage\",\"url\":\"https://docs.weelkit.com/api-reference/article-fields/effective-contract\",\"name\":\"Preview the effective contract\",\"description\":\"Compiles the canonical catalog plus the organization's active custom fields, with the stable schema fingerprint used at generation time.\",\"dateModified\":\"2026-09-03T14:56:01.394Z\",\"isPartOf\":{\"@id\":\"https://docs.weelkit.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.weelkit.com/api-reference/article-fields/effective-contract#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.weelkit.com/api-reference/article-fields/effective-contract#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Organization article fields\",\"item\":\"https://docs.weelkit.com/api-reference/article-fields/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Preview the effective contract\",\"item\":\"https://docs.weelkit.com/api-reference/article-fields/effective-contract\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.weelkit.com/api-reference/article-fields/effective-contract#apireference\",\"headline\":\"Preview the effective contract\",\"name\":\"Preview the effective contract\",\"description\":\"Compiles the canonical catalog plus the organization's active custom fields, with the stable schema fingerprint used at generation time.\",\"url\":\"https://docs.weelkit.com/api-reference/article-fields/effective-contract\",\"mainEntityOfPage\":{\"@id\":\"https://docs.weelkit.com/api-reference/article-fields/effective-contract#webpage\"},\"dateModified\":\"2026-09-03T14:56:01.394Z\",\"publisher\":{\"@id\":\"https://docs.weelkit.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.weelkit.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Weelkit\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Weelkit","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"API reference","groups":[{"group":"API documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Organization article fields","pages":[{"title":"List organization article fields","openapi":"GET /api/v1/organization/article-fields","href":"/api-reference/article-fields/list"},{"title":"Create an article field","openapi":"POST /api/v1/organization/article-fields","description":"Creates a custom article field definition. The backend assigns its stable internal key. Requires the manage:organization permission. Unknown types, invalid options, and invalid defaults are rejected.","href":"/api-reference/article-fields/create"},{"title":"Preview the effective contract","openapi":"GET /api/v1/organization/article-fields/effective-contract","href":"/api-reference/article-fields/effective-contract"},{"title":"Update an article field","openapi":"PUT /api/v1/organization/article-fields/{fieldId}","description":"Updates a definition. Requires the manage:organization permission. The key and fieldType are immutable; expectedRevision must match the loaded revision or the update is rejected with 409.","href":"/api-reference/article-fields/update"},{"title":"Activate or deactivate a field","openapi":"PUT /api/v1/organization/article-fields/{fieldId}/active","href":"/api-reference/article-fields/set-active"},{"title":"Delete an article field","openapi":"DELETE /api/v1/organization/article-fields/{fieldId}","href":"/api-reference/article-fields/delete"},{"title":"Reorder article fields","openapi":"PUT /api/v1/organization/article-fields/order","href":"/api-reference/article-fields/reorder"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","openapi":"GET /api/v1/organization/webhooks","href":"/api-reference/webhooks/list"},{"title":"Create a webhook endpoint","openapi":"POST /api/v1/organization/webhooks","href":"/api-reference/webhooks/create"},{"title":"List subscribable event types","openapi":"GET /api/v1/organization/webhooks/event-types","href":"/api-reference/webhooks/event-types"},{"title":"Update a webhook endpoint","openapi":"PUT /api/v1/organization/webhooks/{endpointId}","href":"/api-reference/webhooks/update"},{"title":"Delete a webhook endpoint","openapi":"DELETE /api/v1/organization/webhooks/{endpointId}","href":"/api-reference/webhooks/delete"},{"title":"Rotate the signing secret","openapi":"POST /api/v1/organization/webhooks/{endpointId}/rotate-secret","href":"/api-reference/webhooks/rotate-secret"},{"title":"Send a test event","openapi":"POST /api/v1/organization/webhooks/{endpointId}/test","href":"/api-reference/webhooks/test"},{"title":"List recent deliveries","openapi":"GET /api/v1/organization/webhooks/{endpointId}/deliveries","href":"/api-reference/webhooks/deliveries"}]},{"group":"WordPress.com","pages":[{"title":"List WordPress.com sites","openapi":"GET /api/v1/integrations/connections/{id}/wordpress-com/sites","href":"/api-reference/wordpress-com/sites"}]}]}]},"title":"Preview the effective contract - Weelkit","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}