Where this field sits when its values are read back on a record.
A contact's custom fields are a jsonb bag keyed by field name, so the card
showing them had no order but the one values happened to be written in —
which put a postcode above the street it belongs under. Ordering the
definitions gives every surface reading additionalData one answer.
Lower first; ties fall back to id, so untouched companies keep the order
they already see.
Follow-up question blocks of a searchable choice field, asked once per
selected entry. Null for every other field and for a searchable choice
without follow-ups.
Configuration for the v2 funnel content blocks (testimonial, FAQ,
countdown, loading, quiz reveal, logos, checklist, html).
One column for all of them: the shapes are disjoint and each is only read
by the block that owns it, so eight nullable columns would buy nothing but
eight migrations. Nullable, so release N-1 keeps serving these rows.
Conditional visibility expression. When set, the field is only shown
to the visitor when the expression evaluates to true against current form values.
Uses the same Expression/ExpressionCondition structure as routing rules.
Computed per request when a public form is served — not persisted.
Populated by PublicFormController.withSigningAvailability.
True when the owning company has used this month's signature allowance, so
the renderer shows this field as temporarily unable to take a signature
instead of a signature pad. The rest of the form still renders and still
submits: these forms are lead capture, and losing the lead would cost the
owner far more than the unsigned document.
For Phone Number field - default country code (e.g., "+1", "+49", "+44").
Used when style is WITH_COUNTRY_CODE_PICKER to set the initial country selection.
{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}
{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}
{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}
{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"meetergo","colors":{"primary":"#2563eb","light":"#3b82f6","dark":"#1d4ed8"},"logo":{"light":"https://mintcdn.com/meetergo/NDOgY9QfmSWwQYKs/logo/icon.svg?fit=max\u0026auto=format\u0026n=NDOgY9QfmSWwQYKs\u0026q=85\u0026s=61dca505b7df3e5fce73917f501b9216","dark":"https://mintcdn.com/meetergo/NDOgY9QfmSWwQYKs/logo/icon.svg?fit=max\u0026auto=format\u0026n=NDOgY9QfmSWwQYKs\u0026q=85\u0026s=61dca505b7df3e5fce73917f501b9216"},"favicon":"https://mintcdn.com/meetergo/NDOgY9QfmSWwQYKs/logo/icon.svg?fit=max\u0026auto=format\u0026n=NDOgY9QfmSWwQYKs\u0026q=85\u0026s=61dca505b7df3e5fce73917f501b9216","api":{"playground":{}},"navbar":{"links":[{"href":"https://my.meetergo.com","label":"Dashboard"}],"primary":{"type":"button","label":"Get Started","href":"https://my.meetergo.com/signup"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/meetergo","x":"https://twitter.com/meetergo"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"meetergo","hasAudioNarration":false,"actualSubdomain":"meetergo","customDomains":["developer.meetergo.com"],"gitSource":{"type":"github","owner":"dominikrapacki","repo":"meetergo-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a967f8249ac06b762a7f27a","collectionId":"d59d50b5-59a4-4a13-af3a-48909a0e2667","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a967f8249ac06b762a7f27a"},"entitlements":{},"buildId":"6aed839a1815a54e8ea5b29c","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"API Reference","count":338},{"language":"default","tag":"Developer Guide","count":40},{"language":"default","tag":"space","count":31},{"language":"default","tag":"Invoicing Documents","count":25},{"language":"default","tag":"CRM Deals","count":22},{"language":"default","tag":"Core Concepts","count":13},{"language":"default","tag":"Appointment V4","count":12},{"language":"default","tag":"Booking Link V4","count":12},{"language":"default","tag":"availability","count":11},{"language":"default","tag":"CRM Attachments","count":11}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"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":"vite-origin","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":"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/data-fields/add-a-new-data-field","slug":"/api-reference/data-fields/add-a-new-data-field","pageMetadata":{"title":"Add a new data field","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json post /data-field","href":"/api-reference/data-fields/add-a-new-data-field","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":"Add a new data field","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json post /data-field","href":"/api-reference/data-fields/add-a-new-data-field","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"addFormField","parameters":["f6c35b96-1c58-4fdc-a7d0-614d534550e4"],"requestBody":"c5e57b41-ee76-4a49-b6b7-60dffd4f0006","responses":{"201":"9fa8a37b-d40f-4b37-b4a5-f1ba9ffc5815","400":"fe325919-6f96-4670-8488-8e46d719e956","401":"717043ad-c87d-4792-8b4b-f82b2d9a2fe6","403":"74ec7a73-7042-46b3-bb0d-9ab97815cb86","429":"677a3682-843a-4672-8bf9-3c3bbd2da0c9"},"security":["915e6d79-4655-4be6-b5e4-6a5c4c7f837d","85947205-d801-420b-ba8f-81c4eba768af","2689c8d7-9f04-4109-b1ac-8d33d08d20f9"],"summary":"Add a new data field","tags":["Data Fields"],"method":"post","type":"path","servers":["eaaa1556-90a7-4132-ba89-356339ee40c9"],"path":"/data-field","baseUrlOptions":["https://api.meetergo.com"],"title":"Add a new data field","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f6c35b96-1c58-4fdc-a7d0-614d534550e4":{"name":"personal","required":false,"in":"query","schema":{"type":"boolean","isRequired":false,"uniqueKey":"","typeLabel":"boolean"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string","isRequired":true,"uniqueKey":"label","typeLabel":"string"},"fieldType":{"type":"string","enum":["email","phone","text-single","text-multi","number","select","checkbox-single","checkbox-multi","radio","slide","url","file","date-of-birth","yes-no","rating","scale","signature","date","time","image","heading","separator","page-break","contact","bank-details","license-plate","info-text","info-image","info-video","currency","location","pdf-template","signature-document","file-download","testimonial","faq","countdown","loading","quiz-reveal","logos","checklist","html","button","address","searchable-choice"],"isRequired":true,"uniqueKey":"fieldType","typeLabel":"enum\u003cstring>"},"target":{"type":"string","enum":["email","firstname","lastname","fullname","phone","marketing_consent","linkedin_profile","other"],"isRequired":true,"uniqueKey":"target","typeLabel":"enum\u003cstring>"},"default":{"type":"boolean","isRequired":true,"uniqueKey":"default","typeLabel":"boolean"},"required":{"type":"boolean","isRequired":true,"uniqueKey":"required","typeLabel":"boolean"},"hidden":{"type":"boolean","isRequired":true,"uniqueKey":"hidden","typeLabel":"boolean"},"locales":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","isRequired":true,"uniqueKey":"locales.items.[INDEX].locale","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"locales.items.[INDEX].label","typeLabel":"string"},"labelRichText":{"type":"object","properties":{"schemaVersion":{"enum":[1],"type":"number","isRequired":true,"uniqueKey":"locales.items.[INDEX].labelRichText.schemaVersion","typeLabel":"enum\u003cnumber>"},"html":{"type":"string","isRequired":true,"uniqueKey":"locales.items.[INDEX].labelRichText.html","typeLabel":"string"}},"required":["schemaVersion","html"],"uniqueKey":"locales.items.[INDEX].labelRichText","typeLabel":"object"},"placeholder":{"type":"string","uniqueKey":"locales.items.[INDEX].placeholder","typeLabel":"string"}},"required":["locale","label"],"uniqueKey":"locales.items.[INDEX]","typeLabel":"object"},"uniqueKey":"locales","typeLabel":"object[]"},"hideUntilChange":{"type":"boolean","uniqueKey":"hideUntilChange","typeLabel":"boolean"},"defaultValue":{"oneOf":[{"type":"string","uniqueKey":"defaultValue.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"defaultValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"defaultValue","typeLabel":"string | null"},"placeholder":{"type":"string","uniqueKey":"placeholder","typeLabel":"string"},"options":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","isRequired":true,"uniqueKey":"options.items.[INDEX].label","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"options.items.[INDEX].value","typeLabel":"string"},"description":{"type":"string","description":"Optional plain-text option description","uniqueKey":"options.items.[INDEX].description","typeLabel":"string"},"labelRichText":{"type":"object","properties":{"schemaVersion":{"enum":[1],"type":"number","isRequired":true,"uniqueKey":"options.items.[INDEX].labelRichText.schemaVersion","typeLabel":"enum\u003cnumber>"},"html":{"type":"string","isRequired":true,"uniqueKey":"options.items.[INDEX].labelRichText.html","typeLabel":"string"}},"required":["schemaVersion","html"],"uniqueKey":"options.items.[INDEX].labelRichText","typeLabel":"object"},"descriptionRichText":{"type":"object","properties":{"schemaVersion":{"enum":[1],"type":"number","isRequired":true,"uniqueKey":"options.items.[INDEX].descriptionRichText.schemaVersion","typeLabel":"enum\u003cnumber>"},"html":{"type":"string","isRequired":true,"uniqueKey":"options.items.[INDEX].descriptionRichText.html","typeLabel":"string"}},"required":["schemaVersion","html"],"uniqueKey":"options.items.[INDEX].descriptionRichText","typeLabel":"object"},"pointValue":{"type":"number","description":"Points awarded when this option is selected (for scored forms)","uniqueKey":"options.items.[INDEX].pointValue","typeLabel":"number"},"locales":{"description":"Translations for the option label, same structure as field-level locales","type":"array","items":{"type":"object","properties":{"locale":{"type":"string","isRequired":true,"uniqueKey":"options.items.[INDEX].locales.items.[INDEX].locale","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"options.items.[INDEX].locales.items.[INDEX].label","typeLabel":"string"},"labelRichText":{"type":"object","properties":{"schemaVersion":{"enum":[1],"type":"number","isRequired":true,"uniqueKey":"options.items.[INDEX].locales.items.[INDEX].labelRichText.schemaVersion","typeLabel":"enum\u003cnumber>"},"html":{"type":"string","isRequired":true,"uniqueKey":"options.items.[INDEX].locales.items.[INDEX].labelRichText.html","typeLabel":"string"}},"required":["schemaVersion","html"],"uniqueKey":"options.items.[INDEX].locales.items.[INDEX].labelRichText","typeLabel":"object"},"placeholder":{"type":"string","uniqueKey":"options.items.[INDEX].locales.items.[INDEX].placeholder","typeLabel":"string"}},"required":["locale","label"],"uniqueKey":"options.items.[INDEX].locales.items.[INDEX]","typeLabel":"object"},"uniqueKey":"options.items.[INDEX].locales","typeLabel":"object[]"},"conditions":{"type":"object","description":"Visibility gate on this single option, same Expression shape as\nfunnel-step conditions: the option renders only while the expression\nholds. Evaluated in the renderer against earlier answers plus the\nrouting context (e.g. `bookingBlockTarget` conditions).","required":["operator","operands"],"properties":{"operator":{"type":"string","enum":["and","or"],"isRequired":true,"uniqueKey":"options.items.[INDEX].conditions.operator","typeLabel":"enum\u003cstring>"},"operands":{"type":"array","items":{"oneOf":[{},{"type":"object","required":["operator","target","customTarget","value"],"properties":{"operator":{"type":"string","enum":["equals","notEqual","lessThan","greaterThan","lessThanOrEqual","moreThanOrEqual","contains","notContains","blank","notBlank","containsAny","containsNone","startsWith"],"isRequired":true,"uniqueKey":"options.items.[INDEX].conditions.operands.items.[INDEX].oneOf.1.operator","typeLabel":"enum\u003cstring>"},"target":{"type":"string","enum":["attendeeEmail","attendeeFullname","attendeeFirstname","attendeeLastname","attendeePhone","attendeePolicyAccepted","attendeeReceiveReminders","attendeeLanguage","attendeeTimezone","attendeeOther","submissionScore","submissionMaxScore","submissionScorePercentage","salesforceField","bookingBlockTarget"],"isRequired":true,"uniqueKey":"options.items.[INDEX].conditions.operands.items.[INDEX].oneOf.1.target","typeLabel":"enum\u003cstring>"},"customTarget":{"type":"string","isRequired":true,"uniqueKey":"options.items.[INDEX].conditions.operands.items.[INDEX].oneOf.1.customTarget","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"options.items.[INDEX].conditions.operands.items.[INDEX].oneOf.1.value","typeLabel":"string"}},"uniqueKey":"options.items.[INDEX].conditions.operands.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"options.items.[INDEX].conditions.operands.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"options.items.[INDEX].conditions.operands","typeLabel":"object[]"}},"uniqueKey":"options.items.[INDEX].conditions","typeLabel":"object"},"followUpBlockId":{"oneOf":[{"type":"string","description":"Searchable choice fields: the follow-up block asked when this option is\nselected (an id from the field's `followUpOptions.blocks`).","uniqueKey":"options.items.[INDEX].followUpBlockId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Searchable choice fields: the follow-up block asked when this option is\nselected (an id from the field's `followUpOptions.blocks`).","uniqueKey":"options.items.[INDEX].followUpBlockId.oneOf.1","typeLabel":"null"}],"uniqueKey":"options.items.[INDEX].followUpBlockId","typeLabel":"string | null"},"exclusive":{"type":"boolean","description":"Searchable choice fields: the option rules out every other one (\"none of\nthese\"). Picking it clears the rest; it asks no follow-ups.","uniqueKey":"options.items.[INDEX].exclusive","typeLabel":"boolean"},"image":{"type":"string","uniqueKey":"options.items.[INDEX].image","typeLabel":"string"},"icon":{"type":"string","uniqueKey":"options.items.[INDEX].icon","typeLabel":"string"},"minValue":{"type":"number","description":"Used by number fields, min value","uniqueKey":"options.items.[INDEX].minValue","typeLabel":"number"},"maxValue":{"type":"number","description":"Used by number fields, max value","uniqueKey":"options.items.[INDEX].maxValue","typeLabel":"number"}},"required":["label","value"],"uniqueKey":"options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"options","typeLabel":"object[]"},"slideOptions":{"type":"object","properties":{"description":{"type":"string","isRequired":true,"uniqueKey":"slideOptions.description","typeLabel":"string"},"multiselect":{"type":"boolean","isRequired":true,"uniqueKey":"slideOptions.multiselect","typeLabel":"boolean"},"type":{"type":"string","enum":["checkbox","page","image","icon"],"isRequired":true,"uniqueKey":"slideOptions.type","typeLabel":"enum\u003cstring>"},"hideLabel":{"type":"boolean","uniqueKey":"slideOptions.hideLabel","typeLabel":"boolean"},"childFields":{"type":"array","description":"Per-page child-field instances inside the slide. The editor owns the\nSlideChildField shape (instanceId, index, dataFieldId, optional inline\ndefinition, legacy `required` flag, etc.). We accept it verbatim and\nkeep the type loose because the legacy import path adds extra fields the\neditor doesn't model. Declaring it on the DTO is what lets a save carry\nchildFields through: without it, class-transformer drops the unknown key\nfrom the request body, so DnD-added children never persist.","items":{"type":"object","uniqueKey":"slideOptions.childFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"slideOptions.childFields","typeLabel":"object[]"}},"required":["description","multiselect","type"],"uniqueKey":"slideOptions","typeLabel":"object"},"fileFieldOptions":{"type":"object","description":"Configuration for file upload fields.\nRequired when fieldType is 'file'.","required":["allowedExtensions","maxFileSizeMB","maxFiles"],"properties":{"allowedExtensions":{"description":"Allowed file extensions (e.g., pdf, docx, jpg)","type":"array","items":{"type":"string","uniqueKey":"fileFieldOptions.allowedExtensions.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"fileFieldOptions.allowedExtensions","typeLabel":"string[]"},"maxFileSizeMB":{"type":"number","description":"Maximum file size in MB","default":5,"isRequired":true,"uniqueKey":"fileFieldOptions.maxFileSizeMB","typeLabel":"number"},"maxFiles":{"type":"number","description":"Maximum number of files","default":1,"isRequired":true,"uniqueKey":"fileFieldOptions.maxFiles","typeLabel":"number"},"enableCameraCapture":{"type":"boolean","description":"Enable camera capture on mobile devices (shows camera/file toggle). Only works when allowedExtensions includes image types.","default":false,"uniqueKey":"fileFieldOptions.enableCameraCapture","typeLabel":"boolean"}},"uniqueKey":"fileFieldOptions","typeLabel":"object"},"min":{"type":"number","description":"Used by number field","uniqueKey":"min","typeLabel":"number"},"max":{"type":"number","description":"Used by number field","uniqueKey":"max","typeLabel":"number"},"showInfobox":{"type":"boolean","uniqueKey":"showInfobox","typeLabel":"boolean"},"infoboxText":{"type":"string","uniqueKey":"infoboxText","typeLabel":"string"},"useMarkdown":{"type":"boolean","description":"When true, field.label is rendered through markdown-it (html: false).\nAllows **bold**, _italic_, `code`, and links in field labels.","default":false,"uniqueKey":"useMarkdown","typeLabel":"boolean"},"requireSignatureOtp":{"type":"boolean","default":false,"uniqueKey":"requireSignatureOtp","typeLabel":"boolean"},"personalData":{"oneOf":[{"type":"boolean","description":"Personal data for the anonymous export; null follows the field type.","uniqueKey":"personalData.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Personal data for the anonymous export; null follows the field type.","uniqueKey":"personalData.oneOf.1","typeLabel":"null"}],"uniqueKey":"personalData","typeLabel":"boolean | null"},"contactOptions":{"type":"object","description":"Configuration for contact composite fields.\nControls which sub-inputs (name, email, phone, address) are shown.","properties":{"company":{"type":"boolean","description":"Company name; becomes the invoice recipient when the field feeds billing","default":false,"uniqueKey":"contactOptions.company","typeLabel":"boolean"},"salutation":{"type":"boolean","default":false,"uniqueKey":"contactOptions.salutation","typeLabel":"boolean"},"firstName":{"type":"boolean","default":true,"uniqueKey":"contactOptions.firstName","typeLabel":"boolean"},"lastName":{"type":"boolean","default":true,"uniqueKey":"contactOptions.lastName","typeLabel":"boolean"},"email":{"type":"boolean","default":true,"uniqueKey":"contactOptions.email","typeLabel":"boolean"},"phone":{"type":"boolean","default":true,"uniqueKey":"contactOptions.phone","typeLabel":"boolean"},"mobile":{"type":"boolean","default":false,"uniqueKey":"contactOptions.mobile","typeLabel":"boolean"},"birthdate":{"type":"boolean","default":false,"uniqueKey":"contactOptions.birthdate","typeLabel":"boolean"},"street":{"type":"boolean","default":false,"uniqueKey":"contactOptions.street","typeLabel":"boolean"},"addressSupplement":{"type":"boolean","default":false,"uniqueKey":"contactOptions.addressSupplement","typeLabel":"boolean"},"zip":{"type":"boolean","default":false,"uniqueKey":"contactOptions.zip","typeLabel":"boolean"},"city":{"type":"boolean","default":false,"uniqueKey":"contactOptions.city","typeLabel":"boolean"},"country":{"type":"boolean","default":false,"uniqueKey":"contactOptions.country","typeLabel":"boolean"},"vatId":{"type":"boolean","description":"USt-IdNr. / VAT ID, for B2B and reverse-charge invoicing","default":false,"uniqueKey":"contactOptions.vatId","typeLabel":"boolean"}},"uniqueKey":"contactOptions","typeLabel":"object"},"helpText":{"type":"string","description":"Optional help text shown below the field in the booking form.","uniqueKey":"helpText","typeLabel":"string"},"bankDetailsOptions":{"type":"object","description":"Configuration for bank details composite fields.\nControls which optional sub-inputs (BIC, account holder, signature) are shown.","properties":{"showBic":{"type":"boolean","default":true,"uniqueKey":"bankDetailsOptions.showBic","typeLabel":"boolean"},"showAccountHolder":{"type":"boolean","default":true,"uniqueKey":"bankDetailsOptions.showAccountHolder","typeLabel":"boolean"},"showSignature":{"type":"boolean","default":false,"uniqueKey":"bankDetailsOptions.showSignature","typeLabel":"boolean"}},"uniqueKey":"bankDetailsOptions","typeLabel":"object"},"licensePlateOptions":{"type":"object","description":"Configuration for license plate fields.\nControls country format validation.","properties":{"countryFilter":{"type":"string","enum":["all","de"],"default":"all","description":"Country format filter: all = any country, de = German format only","uniqueKey":"licensePlateOptions.countryFilter","typeLabel":"enum\u003cstring>"}},"uniqueKey":"licensePlateOptions","typeLabel":"object"},"textFormatOptions":{"oneOf":[{"type":"object","description":"Format rule for short-text fields. `null` clears it.","required":["kind"],"properties":{"kind":{"type":"string","enum":["length","digits","preset","mask"],"isRequired":true,"uniqueKey":"textFormatOptions.oneOf.0.kind","typeLabel":"enum\u003cstring>"},"minLength":{"oneOf":[{"type":"number","minimum":1,"maximum":10000,"description":"kind = length","uniqueKey":"textFormatOptions.oneOf.0.minLength.oneOf.0","typeLabel":"number"},{"type":"null","minimum":1,"maximum":10000,"description":"kind = length","uniqueKey":"textFormatOptions.oneOf.0.minLength.oneOf.1","typeLabel":"null"}],"uniqueKey":"textFormatOptions.oneOf.0.minLength","typeLabel":"number | null"},"maxLength":{"oneOf":[{"type":"number","minimum":1,"maximum":10000,"description":"kind = length","uniqueKey":"textFormatOptions.oneOf.0.maxLength.oneOf.0","typeLabel":"number"},{"type":"null","minimum":1,"maximum":10000,"description":"kind = length","uniqueKey":"textFormatOptions.oneOf.0.maxLength.oneOf.1","typeLabel":"null"}],"uniqueKey":"textFormatOptions.oneOf.0.maxLength","typeLabel":"number | null"},"length":{"oneOf":[{"type":"number","minimum":1,"maximum":64,"description":"kind = digits: exact digit count","uniqueKey":"textFormatOptions.oneOf.0.length.oneOf.0","typeLabel":"number"},{"type":"null","minimum":1,"maximum":64,"description":"kind = digits: exact digit count","uniqueKey":"textFormatOptions.oneOf.0.length.oneOf.1","typeLabel":"null"}],"uniqueKey":"textFormatOptions.oneOf.0.length","typeLabel":"number | null"},"preset":{"oneOf":[{"type":"string","enum":["se_orgnr","de_plz","at_plz","ch_plz","de_steuer_id","pl_nip"],"description":"kind = preset","uniqueKey":"textFormatOptions.oneOf.0.preset.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["se_orgnr","de_plz","at_plz","ch_plz","de_steuer_id","pl_nip"],"description":"kind = preset","uniqueKey":"textFormatOptions.oneOf.0.preset.oneOf.1","typeLabel":"null"}],"uniqueKey":"textFormatOptions.oneOf.0.preset","typeLabel":"enum\u003cstring> | null"},"mask":{"oneOf":[{"type":"string","maxLength":64,"pattern":"/[#A*]/","description":"kind = mask. # = digit, A = letter, * = letter or digit, anything else is a literal.","uniqueKey":"textFormatOptions.oneOf.0.mask.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":64,"pattern":"/[#A*]/","description":"kind = mask. # = digit, A = letter, * = letter or digit, anything else is a literal.","uniqueKey":"textFormatOptions.oneOf.0.mask.oneOf.1","typeLabel":"null"}],"uniqueKey":"textFormatOptions.oneOf.0.mask","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","maxLength":200,"description":"Host-authored message shown instead of the derived one","uniqueKey":"textFormatOptions.oneOf.0.errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":200,"description":"Host-authored message shown instead of the derived one","uniqueKey":"textFormatOptions.oneOf.0.errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"textFormatOptions.oneOf.0.errorMessage","typeLabel":"string | null"}},"uniqueKey":"textFormatOptions.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"textFormatOptions.oneOf.1","typeLabel":"null"}],"uniqueKey":"textFormatOptions","typeLabel":"object | null"},"displayStyle":{"type":"object","description":"Controls how options are displayed for radio/checkbox/select fields.\n'default' - Standard list view\n'card' - Card grid with optional icons","uniqueKey":"displayStyle","typeLabel":"object"},"conditions":{"oneOf":[{"type":"object","description":"Conditional visibility expression. When set, the field is only shown\nwhen the expression evaluates to true against the current form values.","uniqueKey":"conditions.oneOf.0","typeLabel":"object"},{"type":"null","description":"Conditional visibility expression. When set, the field is only shown\nwhen the expression evaluates to true against the current form values.","uniqueKey":"conditions.oneOf.1","typeLabel":"null"}],"uniqueKey":"conditions","typeLabel":"object | null"},"headingLevel":{"type":"number","description":"Heading level for heading fields (1–6). Defaults to 2 (\u003ch2>).","uniqueKey":"headingLevel","typeLabel":"number"},"pdfTemplateOptions":{"type":"object","description":"Configuration for PDF template fields.\nHolds the template PDF reference and pdfme schema JSON.","required":["fileAssetId","pdfmeTemplate","requireSignature"],"properties":{"fileAssetId":{"type":"string","description":"FileAsset ID of the uploaded PDF template","isRequired":true,"uniqueKey":"pdfTemplateOptions.fileAssetId","typeLabel":"string"},"pdfmeTemplate":{"type":"object","description":"pdfme template schema JSON (positions of fields on the PDF). Does not include the basePdf bytes.","isRequired":true,"uniqueKey":"pdfTemplateOptions.pdfmeTemplate","typeLabel":"object"},"requireSignature":{"type":"boolean","description":"When true, respondent must draw a signature before accepting the document.","default":false,"isRequired":true,"uniqueKey":"pdfTemplateOptions.requireSignature","typeLabel":"boolean"},"requireSignatureOtp":{"type":"boolean","description":"When true, respondent must verify their identity via email OTP (FES) before signing.","default":false,"uniqueKey":"pdfTemplateOptions.requireSignatureOtp","typeLabel":"boolean"}},"uniqueKey":"pdfTemplateOptions","typeLabel":"object"},"signatureDocumentOptions":{"oneOf":[{"type":"object","description":"Configuration for signature-document fields.","required":["templateId"],"properties":{"templateId":{"type":"string","description":"Signature template the respondent signs","isRequired":true,"uniqueKey":"signatureDocumentOptions.oneOf.0.templateId","typeLabel":"string"},"roleKey":{"type":"string","description":"Template role the respondent signs as. Defaults to the first.","uniqueKey":"signatureDocumentOptions.oneOf.0.roleKey","typeLabel":"string"},"signers":{"type":"object","description":"Who signs each other role, as a user id of the company. Defaults to the form owner.","uniqueKey":"signatureDocumentOptions.oneOf.0.signers","typeLabel":"object"}},"uniqueKey":"signatureDocumentOptions.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"signatureDocumentOptions.oneOf.1","typeLabel":"null"}],"uniqueKey":"signatureDocumentOptions","typeLabel":"object | null"},"fileDownloadOptions":{"type":"object","description":"Configuration for file download display fields.\nHolds IDs of library files to offer for download.","required":["fileAssetIds"],"properties":{"fileAssetIds":{"description":"FileAsset IDs of library files to offer for download","type":"array","items":{"type":"string","uniqueKey":"fileDownloadOptions.fileAssetIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"fileDownloadOptions.fileAssetIds","typeLabel":"string[]"},"fileNames":{"type":"object","description":"Map of fileAssetId → original filename for display without extra API calls","additionalProperties":{"type":"string","uniqueKey":"fileDownloadOptions.fileNames.additionalProperties","typeLabel":"string"},"uniqueKey":"fileDownloadOptions.fileNames","typeLabel":"object"}},"uniqueKey":"fileDownloadOptions","typeLabel":"object"},"blockOptions":{"type":"object","description":"Configuration for the v2 funnel content blocks (testimonial, FAQ,\ncountdown, loading, quiz reveal, logos, checklist, html).","properties":{"richText":{"type":"object","description":"Rich presentation for this field's semantic label and help text.","properties":{"label":{"type":"object","properties":{"schemaVersion":{"enum":[1],"type":"number","isRequired":true,"uniqueKey":"blockOptions.richText.label.schemaVersion","typeLabel":"enum\u003cnumber>"},"html":{"type":"string","isRequired":true,"uniqueKey":"blockOptions.richText.label.html","typeLabel":"string"}},"required":["schemaVersion","html"],"uniqueKey":"blockOptions.richText.label","typeLabel":"object"},"helpText":{"type":"object","properties":{"schemaVersion":{"enum":[1],"type":"number","isRequired":true,"uniqueKey":"blockOptions.richText.helpText.schemaVersion","typeLabel":"enum\u003cnumber>"},"html":{"type":"string","isRequired":true,"uniqueKey":"blockOptions.richText.helpText.html","typeLabel":"string"}},"required":["schemaVersion","html"],"uniqueKey":"blockOptions.richText.helpText","typeLabel":"object"}},"uniqueKey":"blockOptions.richText","typeLabel":"object"},"testimonials":{"type":"array","items":{"type":"object","properties":{"quote":{"type":"string","isRequired":true,"uniqueKey":"blockOptions.testimonials.items.[INDEX].quote","typeLabel":"string"},"author":{"type":"string","uniqueKey":"blockOptions.testimonials.items.[INDEX].author","typeLabel":"string"},"role":{"type":"string","uniqueKey":"blockOptions.testimonials.items.[INDEX].role","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"blockOptions.testimonials.items.[INDEX].avatarUrl","typeLabel":"string"},"rating":{"type":"number","description":"Star rating, 1-5. Omit for no stars.","uniqueKey":"blockOptions.testimonials.items.[INDEX].rating","typeLabel":"number"}},"required":["quote"],"uniqueKey":"blockOptions.testimonials.items.[INDEX]","typeLabel":"object"},"uniqueKey":"blockOptions.testimonials","typeLabel":"object[]"},"faqs":{"type":"array","items":{"type":"object","properties":{"question":{"type":"string","isRequired":true,"uniqueKey":"blockOptions.faqs.items.[INDEX].question","typeLabel":"string"},"answer":{"type":"string","isRequired":true,"uniqueKey":"blockOptions.faqs.items.[INDEX].answer","typeLabel":"string"}},"required":["question","answer"],"uniqueKey":"blockOptions.faqs.items.[INDEX]","typeLabel":"object"},"uniqueKey":"blockOptions.faqs","typeLabel":"object[]"},"logos":{"type":"array","items":{"type":"object","properties":{"imageUrl":{"type":"string","isRequired":true,"uniqueKey":"blockOptions.logos.items.[INDEX].imageUrl","typeLabel":"string"},"alt":{"type":"string","uniqueKey":"blockOptions.logos.items.[INDEX].alt","typeLabel":"string"}},"required":["imageUrl"],"uniqueKey":"blockOptions.logos.items.[INDEX]","typeLabel":"object"},"uniqueKey":"blockOptions.logos","typeLabel":"object[]"},"checklist":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","isRequired":true,"uniqueKey":"blockOptions.checklist.items.[INDEX].text","typeLabel":"string"}},"required":["text"],"uniqueKey":"blockOptions.checklist.items.[INDEX]","typeLabel":"object"},"uniqueKey":"blockOptions.checklist","typeLabel":"object[]"},"countdown":{"type":"object","properties":{"mode":{"type":"string","enum":["date","duration"],"isRequired":true,"uniqueKey":"blockOptions.countdown.mode","typeLabel":"enum\u003cstring>"},"endsAt":{"type":"string","description":"ISO 8601 instant, `date` mode only","uniqueKey":"blockOptions.countdown.endsAt","typeLabel":"string"},"durationSeconds":{"type":"number","description":"Countdown length, `duration` mode only","uniqueKey":"blockOptions.countdown.durationSeconds","typeLabel":"number"},"expiredText":{"type":"string","uniqueKey":"blockOptions.countdown.expiredText","typeLabel":"string"},"hideWhenExpired":{"type":"boolean","uniqueKey":"blockOptions.countdown.hideWhenExpired","typeLabel":"boolean"}},"required":["mode"],"uniqueKey":"blockOptions.countdown","typeLabel":"object"},"loading":{"type":"object","properties":{"durationSeconds":{"type":"number","isRequired":true,"uniqueKey":"blockOptions.loading.durationSeconds","typeLabel":"number"},"steps":{"type":"array","items":{"type":"string","uniqueKey":"blockOptions.loading.steps.items.[INDEX]","typeLabel":"string"},"uniqueKey":"blockOptions.loading.steps","typeLabel":"string[]"}},"required":["durationSeconds"],"uniqueKey":"blockOptions.loading","typeLabel":"object"},"quizReveal":{"type":"object","properties":{"tiers":{"type":"array","items":{"type":"object","properties":{"minScorePercent":{"type":"number","description":"Lowest score percentage (0-100) landing here","isRequired":true,"uniqueKey":"blockOptions.quizReveal.tiers.items.[INDEX].minScorePercent","typeLabel":"number"},"title":{"type":"string","isRequired":true,"uniqueKey":"blockOptions.quizReveal.tiers.items.[INDEX].title","typeLabel":"string"},"body":{"type":"string","uniqueKey":"blockOptions.quizReveal.tiers.items.[INDEX].body","typeLabel":"string"},"imageUrl":{"type":"string","uniqueKey":"blockOptions.quizReveal.tiers.items.[INDEX].imageUrl","typeLabel":"string"}},"required":["minScorePercent","title"],"uniqueKey":"blockOptions.quizReveal.tiers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"blockOptions.quizReveal.tiers","typeLabel":"object[]"}},"required":["tiers"],"uniqueKey":"blockOptions.quizReveal","typeLabel":"object"},"html":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"blockOptions.html.code","typeLabel":"string"}},"required":["code"],"uniqueKey":"blockOptions.html","typeLabel":"object"},"button":{"type":"object","properties":{"text":{"type":"string","maxLength":120,"isRequired":true,"uniqueKey":"blockOptions.button.text","typeLabel":"string"},"action":{"type":"string","enum":["next","link"],"isRequired":true,"uniqueKey":"blockOptions.button.action","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"https URL, `link` action only","maxLength":2000,"format":"uri","uniqueKey":"blockOptions.button.url","typeLabel":"string\u003curi>"},"align":{"type":"string","enum":["left","center","right"],"uniqueKey":"blockOptions.button.align","typeLabel":"enum\u003cstring>"}},"required":["text","action"],"uniqueKey":"blockOptions.button","typeLabel":"object"}},"uniqueKey":"blockOptions","typeLabel":"object"},"followUpOptions":{"oneOf":[{"type":"object","description":"Follow-up question blocks of a searchable choice field. Normalized by the\nrepository (`normalizeFollowUpOptions`); `null` clears it.","additionalProperties":true,"uniqueKey":"followUpOptions.oneOf.0","typeLabel":"object"},{"type":"null","description":"Follow-up question blocks of a searchable choice field. Normalized by the\nrepository (`normalizeFollowUpOptions`); `null` clears it.","additionalProperties":true,"uniqueKey":"followUpOptions.oneOf.1","typeLabel":"null"}],"uniqueKey":"followUpOptions","typeLabel":"object | null"}},"required":["label","fieldType","target","default","required","hidden"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"label":"\u003cstring>","default":true,"required":true,"hidden":true,"locales":[{"locale":"\u003cstring>","label":"\u003cstring>","placeholder":"\u003cstring>"}],"hideUntilChange":true,"defaultValue":"\u003cstring>","placeholder":"\u003cstring>","options":[{"label":"\u003cstring>","value":"\u003cstring>","description":"\u003cstring>","pointValue":123,"locales":[{"locale":"\u003cstring>","label":"\u003cstring>","placeholder":"\u003cstring>"}],"followUpBlockId":"\u003cstring>","exclusive":true,"image":"\u003cstring>","icon":"\u003cstring>","minValue":123,"maxValue":123}],"min":123,"max":123,"showInfobox":true,"infoboxText":"\u003cstring>","useMarkdown":false,"requireSignatureOtp":false,"personalData":true,"contactOptions":{"company":false,"salutation":false,"firstName":true,"lastName":true,"email":true,"phone":true,"mobile":false,"birthdate":false,"street":false,"addressSupplement":false,"zip":false,"city":false,"country":false,"vatId":false},"helpText":"\u003cstring>","bankDetailsOptions":{"showBic":true,"showAccountHolder":true,"showSignature":false},"licensePlateOptions":{"countryFilter":"all"},"textFormatOptions":{"minLength":5000.5,"maxLength":5000.5,"length":32.5,"mask":"\u003cstring>","errorMessage":"\u003cstring>"},"displayStyle":{},"conditions":{},"headingLevel":123,"signatureDocumentOptions":{"templateId":"\u003cstring>","roleKey":"\u003cstring>","signers":{}},"blockOptions":{"richText":{},"testimonials":[{"quote":"\u003cstring>","author":"\u003cstring>","role":"\u003cstring>","avatarUrl":"\u003cstring>","rating":123}],"faqs":[{"question":"\u003cstring>","answer":"\u003cstring>"}],"logos":[{"imageUrl":"\u003cstring>","alt":"\u003cstring>"}],"checklist":[{"text":"\u003cstring>"}]},"followUpOptions":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"9fa8a37b-d40f-4b37-b4a5-f1ba9ffc5815":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"id","typeLabel":"number"},"label":{"type":"string","isRequired":true,"uniqueKey":"label","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"target":{"type":"string","enum":["email","firstname","lastname","fullname","phone","marketing_consent","linkedin_profile","other"],"isRequired":true,"uniqueKey":"target","typeLabel":"enum\u003cstring>"},"fieldType":{"type":"string","enum":["email","phone","text-single","text-multi","number","select","checkbox-single","checkbox-multi","radio","slide","url","file","date-of-birth","yes-no","rating","scale","signature","date","time","image","heading","separator","page-break","contact","bank-details","license-plate","info-text","info-image","info-video","currency","location","pdf-template","signature-document","file-download","testimonial","faq","countdown","loading","quiz-reveal","logos","checklist","html","button","address","searchable-choice"],"isRequired":true,"uniqueKey":"fieldType","typeLabel":"enum\u003cstring>"},"order":{"type":"number","description":"Where this field sits when its values are read back on a record.\n\nA contact's custom fields are a jsonb bag keyed by field name, so the card\nshowing them had no order but the one values happened to be written in —\nwhich put a postcode above the street it belongs under. Ordering the\ndefinitions gives every surface reading `additionalData` one answer.\nLower first; ties fall back to id, so untouched companies keep the order\nthey already see.","isRequired":true,"uniqueKey":"order","typeLabel":"number"},"locales":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","isRequired":true,"uniqueKey":"locales.items.[INDEX].locale","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"locales.items.[INDEX].label","typeLabel":"string"},"labelRichText":{"type":"object","properties":{"schemaVersion":{"enum":[1],"type":"number","isRequired":true,"uniqueKey":"locales.items.[INDEX].labelRichText.schemaVersion","typeLabel":"enum\u003cnumber>"},"html":{"type":"string","isRequired":true,"uniqueKey":"locales.items.[INDEX].labelRichText.html","typeLabel":"string"}},"required":["schemaVersion","html"],"uniqueKey":"locales.items.[INDEX].labelRichText","typeLabel":"object"},"placeholder":{"type":"string","uniqueKey":"locales.items.[INDEX].placeholder","typeLabel":"string"}},"required":["locale","label"],"uniqueKey":"locales.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"locales","typeLabel":"object[]"},"default":{"type":"boolean","isRequired":true,"uniqueKey":"default","typeLabel":"boolean"},"required":{"type":"boolean","isRequired":true,"uniqueKey":"required","typeLabel":"boolean"},"hidden":{"type":"boolean","isRequired":true,"uniqueKey":"hidden","typeLabel":"boolean"},"hideUntilChange":{"type":"boolean","isRequired":true,"uniqueKey":"hideUntilChange","typeLabel":"boolean"},"mutable":{"type":"boolean","isRequired":true,"uniqueKey":"mutable","typeLabel":"boolean"},"options":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","isRequired":true,"uniqueKey":"options.items.[INDEX].label","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"options.items.[INDEX].value","typeLabel":"string"},"description":{"type":"string","description":"Optional plain-text option description","uniqueKey":"options.items.[INDEX].description","typeLabel":"string"},"labelRichText":{"type":"object","properties":{"schemaVersion":{"enum":[1],"type":"number","isRequired":true,"uniqueKey":"options.items.[INDEX].labelRichText.schemaVersion","typeLabel":"enum\u003cnumber>"},"html":{"type":"string","isRequired":true,"uniqueKey":"options.items.[INDEX].labelRichText.html","typeLabel":"string"}},"required":["schemaVersion","html"],"uniqueKey":"options.items.[INDEX].labelRichText","typeLabel":"object"},"descriptionRichText":{"type":"object","properties":{"schemaVersion":{"enum":[1],"type":"number","isRequired":true,"uniqueKey":"options.items.[INDEX].descriptionRichText.schemaVersion","typeLabel":"enum\u003cnumber>"},"html":{"type":"string","isRequired":true,"uniqueKey":"options.items.[INDEX].descriptionRichText.html","typeLabel":"string"}},"required":["schemaVersion","html"],"uniqueKey":"options.items.[INDEX].descriptionRichText","typeLabel":"object"},"pointValue":{"type":"number","description":"Points awarded when this option is selected (for scored forms)","uniqueKey":"options.items.[INDEX].pointValue","typeLabel":"number"},"locales":{"description":"Translations for the option label, same structure as field-level locales","type":"array","items":{"type":"object","properties":{"locale":{"type":"string","isRequired":true,"uniqueKey":"options.items.[INDEX].locales.items.[INDEX].locale","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"options.items.[INDEX].locales.items.[INDEX].label","typeLabel":"string"},"labelRichText":{"type":"object","properties":{"schemaVersion":{"enum":[1],"type":"number","isRequired":true,"uniqueKey":"options.items.[INDEX].locales.items.[INDEX].labelRichText.schemaVersion","typeLabel":"enum\u003cnumber>"},"html":{"type":"string","isRequired":true,"uniqueKey":"options.items.[INDEX].locales.items.[INDEX].labelRichText.html","typeLabel":"string"}},"required":["schemaVersion","html"],"uniqueKey":"options.items.[INDEX].locales.items.[INDEX].labelRichText","typeLabel":"object"},"placeholder":{"type":"string","uniqueKey":"options.items.[INDEX].locales.items.[INDEX].placeholder","typeLabel":"string"}},"required":["locale","label"],"uniqueKey":"options.items.[INDEX].locales.items.[INDEX]","typeLabel":"object"},"uniqueKey":"options.items.[INDEX].locales","typeLabel":"object[]"},"conditions":{"type":"object","description":"Visibility gate on this single option, same Expression shape as\nfunnel-step conditions: the option renders only while the expression\nholds. Evaluated in the renderer against earlier answers plus the\nrouting context (e.g. `bookingBlockTarget` conditions).","required":["operator","operands"],"properties":{"operator":{"type":"string","enum":["and","or"],"isRequired":true,"uniqueKey":"options.items.[INDEX].conditions.operator","typeLabel":"enum\u003cstring>"},"operands":{"type":"array","items":{"oneOf":[{},{"type":"object","required":["operator","target","customTarget","value"],"properties":{"operator":{"type":"string","enum":["equals","notEqual","lessThan","greaterThan","lessThanOrEqual","moreThanOrEqual","contains","notContains","blank","notBlank","containsAny","containsNone","startsWith"],"isRequired":true,"uniqueKey":"options.items.[INDEX].conditions.operands.items.[INDEX].oneOf.1.operator","typeLabel":"enum\u003cstring>"},"target":{"type":"string","enum":["attendeeEmail","attendeeFullname","attendeeFirstname","attendeeLastname","attendeePhone","attendeePolicyAccepted","attendeeReceiveReminders","attendeeLanguage","attendeeTimezone","attendeeOther","submissionScore","submissionMaxScore","submissionScorePercentage","salesforceField","bookingBlockTarget"],"isRequired":true,"uniqueKey":"options.items.[INDEX].conditions.operands.items.[INDEX].oneOf.1.target","typeLabel":"enum\u003cstring>"},"customTarget":{"type":"string","isRequired":true,"uniqueKey":"options.items.[INDEX].conditions.operands.items.[INDEX].oneOf.1.customTarget","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"options.items.[INDEX].conditions.operands.items.[INDEX].oneOf.1.value","typeLabel":"string"}},"uniqueKey":"options.items.[INDEX].conditions.operands.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"options.items.[INDEX].conditions.operands.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"options.items.[INDEX].conditions.operands","typeLabel":"object[]"}},"uniqueKey":"options.items.[INDEX].conditions","typeLabel":"object"},"followUpBlockId":{"oneOf":[{"type":"string","description":"Searchable choice fields: the follow-up block asked when this option is\nselected (an id from the field's `followUpOptions.blocks`).","uniqueKey":"options.items.[INDEX].followUpBlockId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Searchable choice fields: the follow-up block asked when this option is\nselected (an id from the field's `followUpOptions.blocks`).","uniqueKey":"options.items.[INDEX].followUpBlockId.oneOf.1","typeLabel":"null"}],"uniqueKey":"options.items.[INDEX].followUpBlockId","typeLabel":"string | null"},"exclusive":{"type":"boolean","description":"Searchable choice fields: the option rules out every other one (\"none of\nthese\"). Picking it clears the rest; it asks no follow-ups.","uniqueKey":"options.items.[INDEX].exclusive","typeLabel":"boolean"},"image":{"type":"string","uniqueKey":"options.items.[INDEX].image","typeLabel":"string"},"icon":{"type":"string","uniqueKey":"options.items.[INDEX].icon","typeLabel":"string"},"minValue":{"type":"number","description":"Used by number fields, min value","uniqueKey":"options.items.[INDEX].minValue","typeLabel":"number"},"maxValue":{"type":"number","description":"Used by number fields, max value","uniqueKey":"options.items.[INDEX].maxValue","typeLabel":"number"}},"required":["label","value"],"uniqueKey":"options.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"options","typeLabel":"object[]"},"createdAt":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"showInfobox":{"type":"boolean","description":"Only for data fields of type slide, enable to show an infobox.","isRequired":true,"uniqueKey":"showInfobox","typeLabel":"boolean"},"companyId":{"type":"string","isRequired":true,"uniqueKey":"companyId","typeLabel":"string"},"useMarkdown":{"type":"boolean","description":"When true, field.label is rendered through markdown-it (html: false).\nAllows **bold**, _italic_, `code`, and links in field labels.","isRequired":true,"uniqueKey":"useMarkdown","typeLabel":"boolean"},"requireSignatureOtp":{"type":"boolean","description":"When true, the signer must verify their email via OTP before the signature canvas is unlocked.","isRequired":true,"uniqueKey":"requireSignatureOtp","typeLabel":"boolean"},"personalData":{"oneOf":[{"type":"boolean","description":"Whether the answer identifies the respondent, for the anonymous results\nexport. Null follows the field type (see isPersonalField).","uniqueKey":"personalData.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the answer identifies the respondent, for the anonymous results\nexport. Null follows the field type (see isPersonalField).","uniqueKey":"personalData.oneOf.1","typeLabel":"null"}],"uniqueKey":"personalData","typeLabel":"boolean | null"},"defaultValue":{"type":"string","uniqueKey":"defaultValue","typeLabel":"string"},"placeholder":{"type":"string","uniqueKey":"placeholder","typeLabel":"string"},"slideOptions":{"type":"object","properties":{"description":{"type":"string","isRequired":true,"uniqueKey":"slideOptions.description","typeLabel":"string"},"multiselect":{"type":"boolean","isRequired":true,"uniqueKey":"slideOptions.multiselect","typeLabel":"boolean"},"type":{"type":"string","enum":["checkbox","page","image","icon"],"isRequired":true,"uniqueKey":"slideOptions.type","typeLabel":"enum\u003cstring>"},"hideLabel":{"type":"boolean","uniqueKey":"slideOptions.hideLabel","typeLabel":"boolean"},"childFields":{"type":"array","description":"Per-page child-field instances inside the slide. The editor owns the\nSlideChildField shape (instanceId, index, dataFieldId, optional inline\ndefinition, legacy `required` flag, etc.). We accept it verbatim and\nkeep the type loose because the legacy import path adds extra fields the\neditor doesn't model. Declaring it on the DTO is what lets a save carry\nchildFields through: without it, class-transformer drops the unknown key\nfrom the request body, so DnD-added children never persist.","items":{"type":"object","uniqueKey":"slideOptions.childFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"slideOptions.childFields","typeLabel":"object[]"}},"required":["description","multiselect","type"],"uniqueKey":"slideOptions","typeLabel":"object"},"fileFieldOptions":{"type":"object","description":"Configuration for file upload fields.\nOnly used when fieldType is 'file'.","required":["allowedExtensions","maxFileSizeMB","maxFiles"],"properties":{"allowedExtensions":{"description":"Allowed file extensions (e.g., pdf, docx, jpg)","type":"array","items":{"type":"string","uniqueKey":"fileFieldOptions.allowedExtensions.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"fileFieldOptions.allowedExtensions","typeLabel":"string[]"},"maxFileSizeMB":{"type":"number","description":"Maximum file size in MB","default":5,"isRequired":true,"uniqueKey":"fileFieldOptions.maxFileSizeMB","typeLabel":"number"},"maxFiles":{"type":"number","description":"Maximum number of files","default":1,"isRequired":true,"uniqueKey":"fileFieldOptions.maxFiles","typeLabel":"number"},"enableCameraCapture":{"type":"boolean","description":"Enable camera capture on mobile devices (shows camera/file toggle). Only works when allowedExtensions includes image types.","default":false,"uniqueKey":"fileFieldOptions.enableCameraCapture","typeLabel":"boolean"}},"uniqueKey":"fileFieldOptions","typeLabel":"object"},"contactOptions":{"type":"object","description":"Configuration for contact composite fields.\nControls which sub-inputs (name, email, phone, address, etc.) are shown.","properties":{"company":{"type":"boolean","description":"Company name; becomes the invoice recipient when the field feeds billing","default":false,"uniqueKey":"contactOptions.company","typeLabel":"boolean"},"salutation":{"type":"boolean","default":false,"uniqueKey":"contactOptions.salutation","typeLabel":"boolean"},"firstName":{"type":"boolean","default":true,"uniqueKey":"contactOptions.firstName","typeLabel":"boolean"},"lastName":{"type":"boolean","default":true,"uniqueKey":"contactOptions.lastName","typeLabel":"boolean"},"email":{"type":"boolean","default":true,"uniqueKey":"contactOptions.email","typeLabel":"boolean"},"phone":{"type":"boolean","default":true,"uniqueKey":"contactOptions.phone","typeLabel":"boolean"},"mobile":{"type":"boolean","default":false,"uniqueKey":"contactOptions.mobile","typeLabel":"boolean"},"birthdate":{"type":"boolean","default":false,"uniqueKey":"contactOptions.birthdate","typeLabel":"boolean"},"street":{"type":"boolean","default":false,"uniqueKey":"contactOptions.street","typeLabel":"boolean"},"addressSupplement":{"type":"boolean","default":false,"uniqueKey":"contactOptions.addressSupplement","typeLabel":"boolean"},"zip":{"type":"boolean","default":false,"uniqueKey":"contactOptions.zip","typeLabel":"boolean"},"city":{"type":"boolean","default":false,"uniqueKey":"contactOptions.city","typeLabel":"boolean"},"country":{"type":"boolean","default":false,"uniqueKey":"contactOptions.country","typeLabel":"boolean"},"vatId":{"type":"boolean","description":"USt-IdNr. / VAT ID, for B2B and reverse-charge invoicing","default":false,"uniqueKey":"contactOptions.vatId","typeLabel":"boolean"}},"uniqueKey":"contactOptions","typeLabel":"object"},"hubspotContactField":{"type":"string","uniqueKey":"hubspotContactField","typeLabel":"string"},"hubspotCompanyField":{"type":"string","uniqueKey":"hubspotCompanyField","typeLabel":"string"},"smartWeContactField":{"type":"string","uniqueKey":"smartWeContactField","typeLabel":"string"},"smartWeCompanyField":{"type":"string","uniqueKey":"smartWeCompanyField","typeLabel":"string"},"pipedriveContactField":{"type":"string","uniqueKey":"pipedriveContactField","typeLabel":"string"},"closeContactField":{"type":"string","uniqueKey":"closeContactField","typeLabel":"string"},"salesforceContactField":{"type":"string","uniqueKey":"salesforceContactField","typeLabel":"string"},"salesforceLeadField":{"type":"string","uniqueKey":"salesforceLeadField","typeLabel":"string"},"salesforceCaseField":{"type":"string","uniqueKey":"salesforceCaseField","typeLabel":"string"},"salesforceOpportunityField":{"type":"string","uniqueKey":"salesforceOpportunityField","typeLabel":"string"},"salesforceAccountField":{"type":"string","uniqueKey":"salesforceAccountField","typeLabel":"string"},"deletedAt":{"oneOf":[{"type":"string","uniqueKey":"deletedAt.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"deletedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"deletedAt","typeLabel":"string | null"},"helpText":{"type":"string","description":"Optional help text shown below the field in the booking form.\nProvides additional guidance to users filling out the form.","uniqueKey":"helpText","typeLabel":"string"},"bankDetailsOptions":{"type":"object","description":"Configuration for bank details composite fields.\nControls which optional sub-inputs (BIC, account holder, signature) are shown.","properties":{"showBic":{"type":"boolean","default":true,"uniqueKey":"bankDetailsOptions.showBic","typeLabel":"boolean"},"showAccountHolder":{"type":"boolean","default":true,"uniqueKey":"bankDetailsOptions.showAccountHolder","typeLabel":"boolean"},"showSignature":{"type":"boolean","default":false,"uniqueKey":"bankDetailsOptions.showSignature","typeLabel":"boolean"}},"uniqueKey":"bankDetailsOptions","typeLabel":"object"},"licensePlateOptions":{"type":"object","description":"Configuration for license plate fields.\nControls country format validation.","properties":{"countryFilter":{"type":"string","enum":["all","de"],"default":"all","description":"Country format filter: all = any country, de = German format only","uniqueKey":"licensePlateOptions.countryFilter","typeLabel":"enum\u003cstring>"}},"uniqueKey":"licensePlateOptions","typeLabel":"object"},"textFormatOptions":{"oneOf":[{"type":"object","description":"Format rule for short-text fields (character count, digit count, country\npreset or mask). Null means no rule, which is every pre-existing field.","required":["kind"],"properties":{"kind":{"type":"string","enum":["length","digits","preset","mask"],"isRequired":true,"uniqueKey":"textFormatOptions.oneOf.0.kind","typeLabel":"enum\u003cstring>"},"minLength":{"oneOf":[{"type":"number","minimum":1,"maximum":10000,"description":"kind = length","uniqueKey":"textFormatOptions.oneOf.0.minLength.oneOf.0","typeLabel":"number"},{"type":"null","minimum":1,"maximum":10000,"description":"kind = length","uniqueKey":"textFormatOptions.oneOf.0.minLength.oneOf.1","typeLabel":"null"}],"uniqueKey":"textFormatOptions.oneOf.0.minLength","typeLabel":"number | null"},"maxLength":{"oneOf":[{"type":"number","minimum":1,"maximum":10000,"description":"kind = length","uniqueKey":"textFormatOptions.oneOf.0.maxLength.oneOf.0","typeLabel":"number"},{"type":"null","minimum":1,"maximum":10000,"description":"kind = length","uniqueKey":"textFormatOptions.oneOf.0.maxLength.oneOf.1","typeLabel":"null"}],"uniqueKey":"textFormatOptions.oneOf.0.maxLength","typeLabel":"number | null"},"length":{"oneOf":[{"type":"number","minimum":1,"maximum":64,"description":"kind = digits: exact digit count","uniqueKey":"textFormatOptions.oneOf.0.length.oneOf.0","typeLabel":"number"},{"type":"null","minimum":1,"maximum":64,"description":"kind = digits: exact digit count","uniqueKey":"textFormatOptions.oneOf.0.length.oneOf.1","typeLabel":"null"}],"uniqueKey":"textFormatOptions.oneOf.0.length","typeLabel":"number | null"},"preset":{"oneOf":[{"type":"string","enum":["se_orgnr","de_plz","at_plz","ch_plz","de_steuer_id","pl_nip"],"description":"kind = preset","uniqueKey":"textFormatOptions.oneOf.0.preset.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["se_orgnr","de_plz","at_plz","ch_plz","de_steuer_id","pl_nip"],"description":"kind = preset","uniqueKey":"textFormatOptions.oneOf.0.preset.oneOf.1","typeLabel":"null"}],"uniqueKey":"textFormatOptions.oneOf.0.preset","typeLabel":"enum\u003cstring> | null"},"mask":{"oneOf":[{"type":"string","maxLength":64,"pattern":"/[#A*]/","description":"kind = mask. # = digit, A = letter, * = letter or digit, anything else is a literal.","uniqueKey":"textFormatOptions.oneOf.0.mask.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":64,"pattern":"/[#A*]/","description":"kind = mask. # = digit, A = letter, * = letter or digit, anything else is a literal.","uniqueKey":"textFormatOptions.oneOf.0.mask.oneOf.1","typeLabel":"null"}],"uniqueKey":"textFormatOptions.oneOf.0.mask","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","maxLength":200,"description":"Host-authored message shown instead of the derived one","uniqueKey":"textFormatOptions.oneOf.0.errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":200,"description":"Host-authored message shown instead of the derived one","uniqueKey":"textFormatOptions.oneOf.0.errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"textFormatOptions.oneOf.0.errorMessage","typeLabel":"string | null"}},"uniqueKey":"textFormatOptions.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"textFormatOptions.oneOf.1","typeLabel":"null"}],"uniqueKey":"textFormatOptions","typeLabel":"object | null"},"followUpOptions":{"oneOf":[{"type":"object","description":"Follow-up question blocks of a searchable choice field, asked once per\nselected entry. Null for every other field and for a searchable choice\nwithout follow-ups.","uniqueKey":"followUpOptions.oneOf.0","typeLabel":"object"},{"type":"null","description":"Follow-up question blocks of a searchable choice field, asked once per\nselected entry. Null for every other field and for a searchable choice\nwithout follow-ups.","uniqueKey":"followUpOptions.oneOf.1","typeLabel":"null"}],"uniqueKey":"followUpOptions","typeLabel":"object | null"},"pdfTemplateOptions":{"type":"object","description":"Configuration for PDF template fields.\nHolds the uploaded template PDF reference and pdfme schema JSON.","required":["fileAssetId","pdfmeTemplate","requireSignature"],"properties":{"fileAssetId":{"type":"string","description":"FileAsset ID of the uploaded PDF template","isRequired":true,"uniqueKey":"pdfTemplateOptions.fileAssetId","typeLabel":"string"},"pdfmeTemplate":{"type":"object","description":"pdfme template schema JSON (positions of fields on the PDF). Does not include the basePdf bytes.","isRequired":true,"uniqueKey":"pdfTemplateOptions.pdfmeTemplate","typeLabel":"object"},"requireSignature":{"type":"boolean","description":"When true, respondent must draw a signature before accepting the document.","default":false,"isRequired":true,"uniqueKey":"pdfTemplateOptions.requireSignature","typeLabel":"boolean"},"requireSignatureOtp":{"type":"boolean","description":"When true, respondent must verify their identity via email OTP (FES) before signing.","default":false,"uniqueKey":"pdfTemplateOptions.requireSignatureOtp","typeLabel":"boolean"}},"uniqueKey":"pdfTemplateOptions","typeLabel":"object"},"signatureDocumentOptions":{"oneOf":[{"type":"object","description":"Configuration for signature-document fields: template and signer role.","required":["templateId"],"properties":{"templateId":{"type":"string","description":"Signature template the respondent signs","isRequired":true,"uniqueKey":"signatureDocumentOptions.oneOf.0.templateId","typeLabel":"string"},"roleKey":{"type":"string","description":"Template role the respondent signs as. Defaults to the first.","uniqueKey":"signatureDocumentOptions.oneOf.0.roleKey","typeLabel":"string"},"signers":{"type":"object","description":"Who signs each other role, as a user id of the company. Defaults to the form owner.","uniqueKey":"signatureDocumentOptions.oneOf.0.signers","typeLabel":"object"}},"uniqueKey":"signatureDocumentOptions.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"signatureDocumentOptions.oneOf.1","typeLabel":"null"}],"uniqueKey":"signatureDocumentOptions","typeLabel":"object | null"},"fileDownloadOptions":{"type":"object","description":"Configuration for file download display fields.\nHolds IDs of library files to offer for download.","required":["fileAssetIds"],"properties":{"fileAssetIds":{"description":"FileAsset IDs of library files to offer for download","type":"array","items":{"type":"string","uniqueKey":"fileDownloadOptions.fileAssetIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"fileDownloadOptions.fileAssetIds","typeLabel":"string[]"},"fileNames":{"type":"object","description":"Map of fileAssetId → original filename for display without extra API calls","additionalProperties":{"type":"string","uniqueKey":"fileDownloadOptions.fileNames.additionalProperties","typeLabel":"string"},"uniqueKey":"fileDownloadOptions.fileNames","typeLabel":"object"}},"uniqueKey":"fileDownloadOptions","typeLabel":"object"},"blockOptions":{"type":"object","description":"Configuration for the v2 funnel content blocks (testimonial, FAQ,\ncountdown, loading, quiz reveal, logos, checklist, html).\n\nOne column for all of them: the shapes are disjoint and each is only read\nby the block that owns it, so eight nullable columns would buy nothing but\neight migrations. Nullable, so release N-1 keeps serving these rows.","properties":{"richText":{"type":"object","description":"Rich presentation for this field's semantic label and help text.","properties":{"label":{"type":"object","properties":{"schemaVersion":{"enum":[1],"type":"number","isRequired":true,"uniqueKey":"blockOptions.richText.label.schemaVersion","typeLabel":"enum\u003cnumber>"},"html":{"type":"string","isRequired":true,"uniqueKey":"blockOptions.richText.label.html","typeLabel":"string"}},"required":["schemaVersion","html"],"uniqueKey":"blockOptions.richText.label","typeLabel":"object"},"helpText":{"type":"object","properties":{"schemaVersion":{"enum":[1],"type":"number","isRequired":true,"uniqueKey":"blockOptions.richText.helpText.schemaVersion","typeLabel":"enum\u003cnumber>"},"html":{"type":"string","isRequired":true,"uniqueKey":"blockOptions.richText.helpText.html","typeLabel":"string"}},"required":["schemaVersion","html"],"uniqueKey":"blockOptions.richText.helpText","typeLabel":"object"}},"uniqueKey":"blockOptions.richText","typeLabel":"object"},"testimonials":{"type":"array","items":{"type":"object","properties":{"quote":{"type":"string","isRequired":true,"uniqueKey":"blockOptions.testimonials.items.[INDEX].quote","typeLabel":"string"},"author":{"type":"string","uniqueKey":"blockOptions.testimonials.items.[INDEX].author","typeLabel":"string"},"role":{"type":"string","uniqueKey":"blockOptions.testimonials.items.[INDEX].role","typeLabel":"string"},"avatarUrl":{"type":"string","uniqueKey":"blockOptions.testimonials.items.[INDEX].avatarUrl","typeLabel":"string"},"rating":{"type":"number","description":"Star rating, 1-5. Omit for no stars.","uniqueKey":"blockOptions.testimonials.items.[INDEX].rating","typeLabel":"number"}},"required":["quote"],"uniqueKey":"blockOptions.testimonials.items.[INDEX]","typeLabel":"object"},"uniqueKey":"blockOptions.testimonials","typeLabel":"object[]"},"faqs":{"type":"array","items":{"type":"object","properties":{"question":{"type":"string","isRequired":true,"uniqueKey":"blockOptions.faqs.items.[INDEX].question","typeLabel":"string"},"answer":{"type":"string","isRequired":true,"uniqueKey":"blockOptions.faqs.items.[INDEX].answer","typeLabel":"string"}},"required":["question","answer"],"uniqueKey":"blockOptions.faqs.items.[INDEX]","typeLabel":"object"},"uniqueKey":"blockOptions.faqs","typeLabel":"object[]"},"logos":{"type":"array","items":{"type":"object","properties":{"imageUrl":{"type":"string","isRequired":true,"uniqueKey":"blockOptions.logos.items.[INDEX].imageUrl","typeLabel":"string"},"alt":{"type":"string","uniqueKey":"blockOptions.logos.items.[INDEX].alt","typeLabel":"string"}},"required":["imageUrl"],"uniqueKey":"blockOptions.logos.items.[INDEX]","typeLabel":"object"},"uniqueKey":"blockOptions.logos","typeLabel":"object[]"},"checklist":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","isRequired":true,"uniqueKey":"blockOptions.checklist.items.[INDEX].text","typeLabel":"string"}},"required":["text"],"uniqueKey":"blockOptions.checklist.items.[INDEX]","typeLabel":"object"},"uniqueKey":"blockOptions.checklist","typeLabel":"object[]"},"countdown":{"type":"object","properties":{"mode":{"type":"string","enum":["date","duration"],"isRequired":true,"uniqueKey":"blockOptions.countdown.mode","typeLabel":"enum\u003cstring>"},"endsAt":{"type":"string","description":"ISO 8601 instant, `date` mode only","uniqueKey":"blockOptions.countdown.endsAt","typeLabel":"string"},"durationSeconds":{"type":"number","description":"Countdown length, `duration` mode only","uniqueKey":"blockOptions.countdown.durationSeconds","typeLabel":"number"},"expiredText":{"type":"string","uniqueKey":"blockOptions.countdown.expiredText","typeLabel":"string"},"hideWhenExpired":{"type":"boolean","uniqueKey":"blockOptions.countdown.hideWhenExpired","typeLabel":"boolean"}},"required":["mode"],"uniqueKey":"blockOptions.countdown","typeLabel":"object"},"loading":{"type":"object","properties":{"durationSeconds":{"type":"number","isRequired":true,"uniqueKey":"blockOptions.loading.durationSeconds","typeLabel":"number"},"steps":{"type":"array","items":{"type":"string","uniqueKey":"blockOptions.loading.steps.items.[INDEX]","typeLabel":"string"},"uniqueKey":"blockOptions.loading.steps","typeLabel":"string[]"}},"required":["durationSeconds"],"uniqueKey":"blockOptions.loading","typeLabel":"object"},"quizReveal":{"type":"object","properties":{"tiers":{"type":"array","items":{"type":"object","properties":{"minScorePercent":{"type":"number","description":"Lowest score percentage (0-100) landing here","isRequired":true,"uniqueKey":"blockOptions.quizReveal.tiers.items.[INDEX].minScorePercent","typeLabel":"number"},"title":{"type":"string","isRequired":true,"uniqueKey":"blockOptions.quizReveal.tiers.items.[INDEX].title","typeLabel":"string"},"body":{"type":"string","uniqueKey":"blockOptions.quizReveal.tiers.items.[INDEX].body","typeLabel":"string"},"imageUrl":{"type":"string","uniqueKey":"blockOptions.quizReveal.tiers.items.[INDEX].imageUrl","typeLabel":"string"}},"required":["minScorePercent","title"],"uniqueKey":"blockOptions.quizReveal.tiers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"blockOptions.quizReveal.tiers","typeLabel":"object[]"}},"required":["tiers"],"uniqueKey":"blockOptions.quizReveal","typeLabel":"object"},"html":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"blockOptions.html.code","typeLabel":"string"}},"required":["code"],"uniqueKey":"blockOptions.html","typeLabel":"object"},"button":{"type":"object","properties":{"text":{"type":"string","maxLength":120,"isRequired":true,"uniqueKey":"blockOptions.button.text","typeLabel":"string"},"action":{"type":"string","enum":["next","link"],"isRequired":true,"uniqueKey":"blockOptions.button.action","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"https URL, `link` action only","maxLength":2000,"format":"uri","uniqueKey":"blockOptions.button.url","typeLabel":"string\u003curi>"},"align":{"type":"string","enum":["left","center","right"],"uniqueKey":"blockOptions.button.align","typeLabel":"enum\u003cstring>"}},"required":["text","action"],"uniqueKey":"blockOptions.button","typeLabel":"object"}},"uniqueKey":"blockOptions","typeLabel":"object"},"displayStyle":{"type":"object","description":"Controls how options are displayed for radio/checkbox/select fields.\n'default' - Standard list view\n'card' - Card grid with optional icons","uniqueKey":"displayStyle","typeLabel":"object"},"conditions":{"oneOf":[{"type":"object","description":"Conditional visibility expression. When set, the field is only shown\nto the visitor when the expression evaluates to true against current form values.\nUses the same Expression/ExpressionCondition structure as routing rules.","uniqueKey":"conditions.oneOf.0","typeLabel":"object"},{"type":"null","description":"Conditional visibility expression. When set, the field is only shown\nto the visitor when the expression evaluates to true against current form values.\nUses the same Expression/ExpressionCondition structure as routing rules.","uniqueKey":"conditions.oneOf.1","typeLabel":"null"}],"uniqueKey":"conditions","typeLabel":"object | null"},"headingLevel":{"type":"number","description":"Heading level for heading fields (1–6).\nDefaults to 2 (renders as \u003ch2>).","uniqueKey":"headingLevel","typeLabel":"number"},"signingPaused":{"type":"boolean","description":"Computed per request when a public form is served — not persisted.\nPopulated by `PublicFormController.withSigningAvailability`.\n\nTrue when the owning company has used this month's signature allowance, so\nthe renderer shows this field as temporarily unable to take a signature\ninstead of a signature pad. The rest of the form still renders and still\nsubmits: these forms are lead capture, and losing the lead would cost the\nowner far more than the unsigned document.","uniqueKey":"signingPaused","typeLabel":"boolean"},"infoboxText":{"type":"string","description":"Only for data fields of type slide, custom infobox text.","uniqueKey":"infoboxText","typeLabel":"string"},"evalancheFieldId":{"type":"string","uniqueKey":"evalancheFieldId","typeLabel":"string"},"klicktippFieldId":{"type":"string","uniqueKey":"klicktippFieldId","typeLabel":"string"},"min":{"type":"number","description":"Currently used by number field as min value.\nFor string field, it is minimum amount of characters.","uniqueKey":"min","typeLabel":"number"},"max":{"type":"number","uniqueKey":"max","typeLabel":"number"},"style":{"type":"number","description":"For Phone Number field - used to set the style of phone input.\n0 - Simple (Default)\n1 - With country code picker","uniqueKey":"style","typeLabel":"number"},"defaultCountryCode":{"type":"string","description":"For Phone Number field - default country code (e.g., \"+1\", \"+49\", \"+44\").\nUsed when style is WITH_COUNTRY_CODE_PICKER to set the initial country selection.","uniqueKey":"defaultCountryCode","typeLabel":"string"}},"required":["id","label","name","target","fieldType","order","locales","default","required","hidden","hideUntilChange","mutable","options","createdAt","updatedAt","showInfobox","companyId","useMarkdown","requireSignatureOtp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":123,"label":"\u003cstring>","name":"\u003cstring>","target":"email","fieldType":"email","order":123,"locales":[{"locale":"\u003cstring>","label":"\u003cstring>","labelRichText":{"schemaVersion":1,"html":"\u003cstring>"},"placeholder":"\u003cstring>"}],"default":true,"required":true,"hidden":true,"hideUntilChange":true,"mutable":true,"options":[{"label":"\u003cstring>","value":"\u003cstring>","description":"\u003cstring>","labelRichText":{"schemaVersion":1,"html":"\u003cstring>"},"descriptionRichText":{"schemaVersion":1,"html":"\u003cstring>"},"pointValue":123,"locales":[{"locale":"\u003cstring>","label":"\u003cstring>","labelRichText":{"schemaVersion":1,"html":"\u003cstring>"},"placeholder":"\u003cstring>"}],"conditions":{"operator":"and","operands":[{"operator":"equals","target":"attendeeEmail","customTarget":"\u003cstring>","value":"\u003cstring>"}]},"followUpBlockId":"\u003cstring>","exclusive":true,"image":"\u003cstring>","icon":"\u003cstring>","minValue":123,"maxValue":123}],"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","showInfobox":true,"companyId":"\u003cstring>","useMarkdown":true,"requireSignatureOtp":true,"personalData":true,"defaultValue":"\u003cstring>","placeholder":"\u003cstring>","slideOptions":{"description":"\u003cstring>","multiselect":true,"type":"checkbox","hideLabel":true,"childFields":[{}]},"fileFieldOptions":{"allowedExtensions":["\u003cstring>"],"maxFileSizeMB":5,"maxFiles":1,"enableCameraCapture":false},"contactOptions":{"company":false,"salutation":false,"firstName":true,"lastName":true,"email":true,"phone":true,"mobile":false,"birthdate":false,"street":false,"addressSupplement":false,"zip":false,"city":false,"country":false,"vatId":false},"hubspotContactField":"\u003cstring>","hubspotCompanyField":"\u003cstring>","smartWeContactField":"\u003cstring>","smartWeCompanyField":"\u003cstring>","pipedriveContactField":"\u003cstring>","closeContactField":"\u003cstring>","salesforceContactField":"\u003cstring>","salesforceLeadField":"\u003cstring>","salesforceCaseField":"\u003cstring>","salesforceOpportunityField":"\u003cstring>","salesforceAccountField":"\u003cstring>","deletedAt":"\u003cstring>","helpText":"\u003cstring>","bankDetailsOptions":{"showBic":true,"showAccountHolder":true,"showSignature":false},"licensePlateOptions":{"countryFilter":"all"},"textFormatOptions":{"kind":"length","minLength":5000.5,"maxLength":5000.5,"length":32.5,"preset":"se_orgnr","mask":"\u003cstring>","errorMessage":"\u003cstring>"},"followUpOptions":{},"pdfTemplateOptions":{"fileAssetId":"\u003cstring>","pdfmeTemplate":{},"requireSignature":false,"requireSignatureOtp":false},"signatureDocumentOptions":{"templateId":"\u003cstring>","roleKey":"\u003cstring>","signers":{}},"fileDownloadOptions":{"fileAssetIds":["\u003cstring>"],"fileNames":{}},"blockOptions":{"richText":{"label":{"schemaVersion":1,"html":"\u003cstring>"},"helpText":{"schemaVersion":1,"html":"\u003cstring>"}},"testimonials":[{"quote":"\u003cstring>","author":"\u003cstring>","role":"\u003cstring>","avatarUrl":"\u003cstring>","rating":123}],"faqs":[{"question":"\u003cstring>","answer":"\u003cstring>"}],"logos":[{"imageUrl":"\u003cstring>","alt":"\u003cstring>"}],"checklist":[{"text":"\u003cstring>"}],"countdown":{"mode":"date","endsAt":"\u003cstring>","durationSeconds":123,"expiredText":"\u003cstring>","hideWhenExpired":true},"loading":{"durationSeconds":123,"steps":["\u003cstring>"]},"quizReveal":{"tiers":[{"minScorePercent":123,"title":"\u003cstring>","body":"\u003cstring>","imageUrl":"\u003cstring>"}]},"html":{"code":"\u003cstring>"},"button":{"text":"\u003cstring>","action":"next","url":"\u003cstring>","align":"left"}},"displayStyle":{},"conditions":{},"headingLevel":123,"signingPaused":true,"infoboxText":"\u003cstring>","evalancheFieldId":"\u003cstring>","klicktippFieldId":"\u003cstring>","min":123,"max":123,"style":123,"defaultCountryCode":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"fe325919-6f96-4670-8488-8e46d719e956":{"description":"The request did not validate. `message` lists the constraints that failed.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","message"],"properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"oneOf":[{"type":"string","description":"A sentence, or the list of field constraints that failed. Validation errors name the offending property.","example":["limit must not be greater than 100"],"isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"A sentence, or the list of field constraints that failed. Validation errors name the offending property.","example":["limit must not be greater than 100"],"isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"error":{"type":"string","example":"BadRequestException","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"message":["limit must not be greater than 100"],"error":"BadRequestException"}}},"exampleType":"generated"}},"exampleType":"generated"},"717043ad-c87d-4792-8b4b-f82b2d9a2fe6":{"description":"Missing, malformed, or expired credentials.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","message"],"properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"oneOf":[{"type":"string","description":"A sentence, or the list of field constraints that failed. Validation errors name the offending property.","example":["limit must not be greater than 100"],"isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"A sentence, or the list of field constraints that failed. Validation errors name the offending property.","example":["limit must not be greater than 100"],"isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"error":{"type":"string","example":"BadRequestException","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"message":["limit must not be greater than 100"],"error":"BadRequestException"}}},"exampleType":"generated"}},"exampleType":"generated"},"74ec7a73-7042-46b3-bb0d-9ab97815cb86":{"description":"Authenticated, but not allowed: the plan does not include this feature, or the token is scoped away from it.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","message"],"properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"oneOf":[{"type":"string","description":"A sentence, or the list of field constraints that failed. Validation errors name the offending property.","example":["limit must not be greater than 100"],"isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"A sentence, or the list of field constraints that failed. Validation errors name the offending property.","example":["limit must not be greater than 100"],"isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"error":{"type":"string","example":"BadRequestException","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"message":["limit must not be greater than 100"],"error":"BadRequestException"}}},"exampleType":"generated"}},"exampleType":"generated"},"677a3682-843a-4672-8bf9-3c3bbd2da0c9":{"description":"Rate limited. Back off and retry.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","message"],"properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"oneOf":[{"type":"string","description":"A sentence, or the list of field constraints that failed. Validation errors name the offending property.","example":["limit must not be greater than 100"],"isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"A sentence, or the list of field constraints that failed. Validation errors name the offending property.","example":["limit must not be greater than 100"],"isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"error":{"type":"string","example":"BadRequestException","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"message":["limit must not be greater than 100"],"error":"BadRequestException"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"915e6d79-4655-4be6-b5e4-6a5c4c7f837d":{"ApiKey":{"scheme":"bearer","bearerFormat":"API Key","type":"http","description":"Bearer token: a Platform API Key (format: ak_live:\u003cuuid>:\u003csecret>) or a Personal Access Token (format: rgo-...). PATs always act as the token owner.","scopes":[],"schemeName":"ApiKey"}},"85947205-d801-420b-ba8f-81c4eba768af":{"JWT":{"scheme":"bearer","bearerFormat":"JWT","type":"http","description":"JWT Bearer token for standard user authentication","scopes":[],"schemeName":"JWT"}},"2689c8d7-9f04-4109-b1ac-8d33d08d20f9":{"ApiUserHeader":{"type":"apiKey","in":"header","name":"x-meetergo-api-user-id","description":"User ID to act on behalf of. Platform API Keys only (required with an API Key unless the endpoint states otherwise). Requests authenticated with a Personal Access Token are rejected if this header names another user.","scopes":[],"schemeName":"ApiUserHeader"}}},"servers":{"eaaa1556-90a7-4132-ba89-356339ee40c9":{"url":"https://api.meetergo.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"API Key","type":"http","description":"Bearer token: a Platform API Key (format: ak_live:\u003cuuid>:\u003csecret>) or a Personal Access Token (format: rgo-...). PATs always act as the token owner.","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token: a Platform API Key (format: ak_live:\u003cuuid>:\u003csecret>) or a Personal Access Token (format: rgo-...). PATs always act as the token owner.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKey","name":"Authorization"}],"title":"ApiKey"},{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"JWT","type":"http","description":"JWT Bearer token for standard user authentication","scopes":[],"schemeName":"JWT"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"JWT Bearer token for standard user authentication","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"JWT","name":"Authorization"}],"title":"JWT"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-meetergo-api-user-id","description":"User ID to act on behalf of. Platform API Keys only (required with an API Key unless the endpoint states otherwise). Requests authenticated with a Personal Access Token are rejected if this header names another user.","scopes":[],"schemeName":"ApiUserHeader"},"schema":{"title":"x-meetergo-api-user-id","type":"string","description":"User ID to act on behalf of. Platform API Keys only (required with an API Key unless the endpoint states otherwise). Requests authenticated with a Personal Access Token are rejected if this header names another user.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiUserHeader","name":"x-meetergo-api-user-id"}],"title":"ApiUserHeader"}]},"originalFileLocation":"openapi.json"},"subdomain":"meetergo","siteName":"meetergo","title":"Add a new data field - meetergo","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T07:37:09.493Z","originalFileLocation":"api-reference/data-fields/add-a-new-data-field.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=\"meetergo\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/meetergo/P2nshTH0TYuw-Wj1/_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/meetergo/P2nshTH0TYuw-Wj1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/meetergo/P2nshTH0TYuw-Wj1/_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/meetergo/P2nshTH0TYuw-Wj1/_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/meetergo/P2nshTH0TYuw-Wj1/_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/meetergo/P2nshTH0TYuw-Wj1/_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/meetergo/P2nshTH0TYuw-Wj1/_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/meetergo/P2nshTH0TYuw-Wj1/_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/meetergo/P2nshTH0TYuw-Wj1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Add a new data field - meetergo\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"meetergo\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.meetergo.com/api-reference/data-fields/add-a-new-data-field\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://meetergo.mintlify.site/_mintlify/api/og/v2?division=Data+Fields\u0026amp;title=Add+a+new+data+field\u0026amp;theme=099878a5f0917707877c2845\u0026amp;signature=f330ecbb753195be0fb7b2779285e7aa98575e5cd30989d34ff74d5ba55d3dd1\">\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=\"Add a new data field - meetergo\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://meetergo.mintlify.site/_mintlify/api/og/v2?division=Data+Fields\u0026amp;title=Add+a+new+data+field\u0026amp;theme=099878a5f0917707877c2845\u0026amp;signature=f330ecbb753195be0fb7b2779285e7aa98575e5cd30989d34ff74d5ba55d3dd1\">\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/meetergo/P2nshTH0TYuw-Wj1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"meetergo\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563eb\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.meetergo.com/api-reference/data-fields/add-a-new-data-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/data-fields/add-a-new-data-field.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.meetergo.com/#organization\",\"name\":\"meetergo\",\"url\":\"https://developer.meetergo.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/meetergo/NDOgY9QfmSWwQYKs/logo/icon.svg?fit=max\u0026auto=format\u0026n=NDOgY9QfmSWwQYKs\u0026q=85\u0026s=61dca505b7df3e5fce73917f501b9216\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.meetergo.com#website\",\"name\":\"meetergo\",\"url\":\"https://developer.meetergo.com\",\"publisher\":{\"@id\":\"https://developer.meetergo.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.meetergo.com/api-reference/data-fields/add-a-new-data-field#webpage\",\"url\":\"https://developer.meetergo.com/api-reference/data-fields/add-a-new-data-field\",\"name\":\"Add a new data field\",\"dateModified\":\"2026-11-06T07:37:09.493Z\",\"isPartOf\":{\"@id\":\"https://developer.meetergo.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.meetergo.com/api-reference/data-fields/add-a-new-data-field#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.meetergo.com/api-reference/data-fields/add-a-new-data-field#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Data Fields\",\"item\":\"https://developer.meetergo.com/api-reference/data-fields/upload-an-option-card-image;-returns-a-stable-public-url-to-store-in%60options[]image%60-replaces-the-base64-data-url-workaround-that-bloatedthe-options-jsonb\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Add a new data field\",\"item\":\"https://developer.meetergo.com/api-reference/data-fields/add-a-new-data-field\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.meetergo.com/api-reference/data-fields/add-a-new-data-field#apireference\",\"headline\":\"Add a new data field\",\"name\":\"Add a new data field\",\"url\":\"https://developer.meetergo.com/api-reference/data-fields/add-a-new-data-field\",\"mainEntityOfPage\":{\"@id\":\"https://developer.meetergo.com/api-reference/data-fields/add-a-new-data-field#webpage\"},\"dateModified\":\"2026-11-06T07:37:09.493Z\",\"publisher\":{\"@id\":\"https://developer.meetergo.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.meetergo.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"meetergo\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"meetergo","nav":{"global":null,"tabs":[{"tab":"Developer Guide","pages":[{"title":"Developer Guide","href":"/developer-docs/introduction"}]},{"tab":"API Reference","groups":[{"group":"CRM Contacts","pages":[{"title":"Get crm","deprecated":null,"version":null,"openapi":"/openapi.json get /crm","href":"/api-reference/crm-contacts/get-crm"},{"title":"Create a new contact","deprecated":null,"version":null,"openapi":"/openapi.json post /crm","href":"/api-reference/crm-contacts/create-a-new-contact"},{"title":"Delete crm","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/{id}","href":"/api-reference/crm-contacts/delete-crm"},{"title":"Patch crm","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/{id}","href":"/api-reference/crm-contacts/patch-crm"},{"title":"Get a contact by ID or attendee ID with all its data including form submissions","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/details","href":"/api-reference/crm-contacts/get-a-contact-by-id-or-attendee-id-with-all-its-data-including-form-submissions"},{"title":"Bulk create contacts from CSV import\nThrottled to prevent abuse - max 3 requests per minute per user","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/bulk","href":"/api-reference/crm-contacts/bulk-create-contacts-from-csv-importthrottled-to-prevent-abuse--max-3-requests-per-minute-per-user"},{"title":"Bulk delete contacts. Only contacts belonging to the requesting user's\ncompany are removed; the result reports how many were deleted vs\nskipped so the UI can surface partial failures.\nThrottled tightly — destructive action, max 3 requests per minute.","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/bulk-delete","href":"/api-reference/crm-contacts/bulk-delete-contacts-only-contacts-belonging-to-the-requesting-userscompany-are-removed;-the-result-reports-how-many-were-deleted-vsskipped-so-the-ui-can-surface-partial-failuresthrottled-tightly-—-destructive-action-max-3-requests-per-minute"},{"title":"Get crmcontacts activity","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/contacts/{contactId}/activity","href":"/api-reference/crm-contacts/get-crmcontacts-activity"}]},{"group":"CRM Pipelines","pages":[{"title":"Get crmpipelines","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/pipelines","href":"/api-reference/crm-pipelines/get-crmpipelines"},{"title":"Post crmpipelines","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/pipelines","href":"/api-reference/crm-pipelines/post-crmpipelines"},{"title":"Get crmpipelinesdefault","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/pipelines/default","href":"/api-reference/crm-pipelines/get-crmpipelinesdefault"},{"title":"Get crmpipelines 1","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/pipelines/{id}","href":"/api-reference/crm-pipelines/get-crmpipelines-1"},{"title":"Delete crmpipelines","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/pipelines/{id}","href":"/api-reference/crm-pipelines/delete-crmpipelines"},{"title":"Patch crmpipelines","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/pipelines/{id}","href":"/api-reference/crm-pipelines/patch-crmpipelines"},{"title":"Post crmpipelines stages","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/pipelines/{pipelineId}/stages","href":"/api-reference/crm-pipelines/post-crmpipelines-stages"},{"title":"Patch crmpipelines stagesreorder","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/pipelines/{pipelineId}/stages/reorder","href":"/api-reference/crm-pipelines/patch-crmpipelines-stagesreorder"},{"title":"Delete crmpipelines stages","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/pipelines/{pipelineId}/stages/{stageId}","href":"/api-reference/crm-pipelines/delete-crmpipelines-stages"},{"title":"Patch crmpipelines stages","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/pipelines/{pipelineId}/stages/{stageId}","href":"/api-reference/crm-pipelines/patch-crmpipelines-stages"}]},{"group":"CRM Settings","pages":[{"title":"The custom field definitions for one CRM record type.\n\n`recordType` defaults to `deal` so callers written before companies had\nfields — including a web bundle a browser is still holding — keep getting\nthe list they asked for.","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/settings/custom-fields","href":"/api-reference/crm-settings/the-custom-field-definitions-for-one-crm-record-type`recordtype`-defaults-to-`deal`-so-callers-written-before-companies-hadfields-—-including-a-web-bundle-a-browser-is-still-holding-—-keep-gettingthe-list-they-asked-for"},{"title":"Replace the custom field definitions for one CRM record type.","deprecated":null,"version":null,"openapi":"/openapi.json put /crm/settings/custom-fields","href":"/api-reference/crm-settings/replace-the-custom-field-definitions-for-one-crm-record-type"},{"title":"Get crmsettingslost reasons","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/settings/lost-reasons","href":"/api-reference/crm-settings/get-crmsettingslost-reasons"},{"title":"Put crmsettingslost reasons","deprecated":null,"version":null,"openapi":"/openapi.json put /crm/settings/lost-reasons","href":"/api-reference/crm-settings/put-crmsettingslost-reasons"}]},{"group":"CRM Tasks","pages":[{"title":"Get crmtasks","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/tasks","href":"/api-reference/crm-tasks/get-crmtasks"},{"title":"Post crmtasks","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/tasks","href":"/api-reference/crm-tasks/post-crmtasks"},{"title":"Get crmtaskssummary","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/tasks/summary","href":"/api-reference/crm-tasks/get-crmtaskssummary"},{"title":"Get crmtasksoverdue","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/tasks/overdue","href":"/api-reference/crm-tasks/get-crmtasksoverdue"},{"title":"Get crmtasksupcoming","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/tasks/upcoming","href":"/api-reference/crm-tasks/get-crmtasksupcoming"},{"title":"Get crmtasksby company","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/tasks/by-company/{crmCompanyId}","href":"/api-reference/crm-tasks/get-crmtasksby-company"},{"title":"Get crmtasks 1","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/tasks/{id}","href":"/api-reference/crm-tasks/get-crmtasks-1"},{"title":"Delete crmtasks","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/tasks/{id}","href":"/api-reference/crm-tasks/delete-crmtasks"},{"title":"Patch crmtasks","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/tasks/{id}","href":"/api-reference/crm-tasks/patch-crmtasks"},{"title":"Patch crmtasks complete","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/tasks/{id}/complete","href":"/api-reference/crm-tasks/patch-crmtasks-complete"},{"title":"Patch crmtasks uncomplete","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/tasks/{id}/uncomplete","href":"/api-reference/crm-tasks/patch-crmtasks-uncomplete"}]},{"group":"CRM Deals","pages":[{"title":"Post crmdeals merge","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/deals/{id}/merge","href":"/api-reference/crm-deals/post-crmdeals-merge"},{"title":"The deals that look like duplicates of this one.\n\nRead-only and merges nothing: the operator still picks. Offering the\ncandidates is the whole difference between a merge you use and a merge you\nhave to already know you need.","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{id}/duplicate-candidates","href":"/api-reference/crm-deals/the-deals-that-look-like-duplicates-of-this-oneread-only-and-merges-nothing:-the-operator-still-picks-offering-thecandidates-is-the-whole-difference-between-a-merge-you-use-and-a-merge-youhave-to-already-know-you-need"},{"title":"Contacts this deal is probably about, when none is linked yet.\n\nRead-only and links nothing — the operator confirms, because a wrong link\nmoves a stranger's email and meetings onto the deal.","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{id}/contact-suggestions","href":"/api-reference/crm-deals/contacts-this-deal-is-probably-about-when-none-is-linked-yetread-only-and-links-nothing-—-the-operator-confirms-because-a-wrong-linkmoves-a-strangers-email-and-meetings-onto-the-deal"},{"title":"Get crmdeals","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals","href":"/api-reference/crm-deals/get-crmdeals"},{"title":"Post crmdeals","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/deals","href":"/api-reference/crm-deals/post-crmdeals"},{"title":"Bulk \"import into pipeline\": upsert contacts and create one deal per row.\nThrottled generously so a chunked multi-batch import can complete.","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/deals/bulk-import","href":"/api-reference/crm-deals/bulk-\"import-into-pipeline\":-upsert-contacts-and-create-one-deal-per-rowthrottled-generously-so-a-chunked-multi-batch-import-can-complete"},{"title":"Get crmdealssummary","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/summary","href":"/api-reference/crm-deals/get-crmdealssummary"},{"title":"Get crmdealslimits","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/limits","href":"/api-reference/crm-deals/get-crmdealslimits"},{"title":"Get crmdealspipeline","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/pipeline/{pipelineId}","href":"/api-reference/crm-deals/get-crmdealspipeline"},{"title":"Optimized endpoint for kanban view - returns deals grouped by stage in a single request.\nThis eliminates the need for multiple paginated calls when loading the kanban board.","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/pipeline/{pipelineId}/grouped","href":"/api-reference/crm-deals/optimized-endpoint-for-kanban-view--returns-deals-grouped-by-stage-in-a-single-requestthis-eliminates-the-need-for-multiple-paginated-calls-when-loading-the-kanban-board"},{"title":"Get crmdeals 1","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{id}","href":"/api-reference/crm-deals/get-crmdeals-1"},{"title":"Delete crmdeals","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/deals/{id}","href":"/api-reference/crm-deals/delete-crmdeals"},{"title":"Patch crmdeals","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/deals/{id}","href":"/api-reference/crm-deals/patch-crmdeals"},{"title":"Patch crmdeals won","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/deals/{id}/won","href":"/api-reference/crm-deals/patch-crmdeals-won"},{"title":"Patch crmdeals lost","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/deals/{id}/lost","href":"/api-reference/crm-deals/patch-crmdeals-lost"},{"title":"Patch crmdeals reopen","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/deals/{id}/reopen","href":"/api-reference/crm-deals/patch-crmdeals-reopen"},{"title":"Get crmdeals contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{id}/contacts","href":"/api-reference/crm-deals/get-crmdeals-contacts"},{"title":"Post crmdeals contacts","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/deals/{id}/contacts","href":"/api-reference/crm-deals/post-crmdeals-contacts"},{"title":"Delete crmdeals contacts","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/deals/{id}/contacts/{dealContactId}","href":"/api-reference/crm-deals/delete-crmdeals-contacts"},{"title":"Patch crmdeals contacts","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/deals/{id}/contacts/{dealContactId}","href":"/api-reference/crm-deals/patch-crmdeals-contacts"},{"title":"Get crmdeals activity","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{id}/activity","href":"/api-reference/crm-deals/get-crmdeals-activity"},{"title":"Get crmdeals appointments","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{id}/appointments","href":"/api-reference/crm-deals/get-crmdeals-appointments"}]},{"group":"CRM Companies","pages":[{"title":"Get crmcompanies","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies","href":"/api-reference/crm-companies/get-crmcompanies"},{"title":"Post crmcompanies","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/companies","href":"/api-reference/crm-companies/post-crmcompanies"},{"title":"Get crmcompaniessummary","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies/summary","href":"/api-reference/crm-companies/get-crmcompaniessummary"},{"title":"Get crmcompaniesby domain","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies/by-domain/{domain}","href":"/api-reference/crm-companies/get-crmcompaniesby-domain"},{"title":"Get crmcompanies meeting history","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies/{id}/meeting-history","href":"/api-reference/crm-companies/get-crmcompanies-meeting-history"},{"title":"Get crmcompanies 1","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies/{id}","href":"/api-reference/crm-companies/get-crmcompanies-1"},{"title":"Delete crmcompanies","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/companies/{id}","href":"/api-reference/crm-companies/delete-crmcompanies"},{"title":"Patch crmcompanies","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/companies/{id}","href":"/api-reference/crm-companies/patch-crmcompanies"},{"title":"Get crmcompanies contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies/{id}/contacts","href":"/api-reference/crm-companies/get-crmcompanies-contacts"},{"title":"Get crmcompanies deals","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies/{id}/deals","href":"/api-reference/crm-companies/get-crmcompanies-deals"}]},{"group":"CRM Notes","pages":[{"title":"List notes for a deal, contact, or company","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/notes","href":"/api-reference/crm-notes/list-notes-for-a-deal-contact-or-company"},{"title":"Create a note on a deal, contact, or company","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/notes","href":"/api-reference/crm-notes/create-a-note-on-a-deal-contact-or-company"},{"title":"Delete a note","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/notes/{id}","href":"/api-reference/crm-notes/delete-a-note"},{"title":"Update a note","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/notes/{id}","href":"/api-reference/crm-notes/update-a-note"},{"title":"Get notes for a deal","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{dealId}/notes","href":"/api-reference/crm-notes/get-notes-for-a-deal"},{"title":"Create a note on a deal","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/deals/{dealId}/notes","href":"/api-reference/crm-notes/create-a-note-on-a-deal"},{"title":"Get notes for a contact","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/contacts/{contactId}/notes","href":"/api-reference/crm-notes/get-notes-for-a-contact"},{"title":"Create a note on a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/contacts/{contactId}/notes","href":"/api-reference/crm-notes/create-a-note-on-a-contact"},{"title":"Get notes for a CRM company","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies/{crmCompanyId}/notes","href":"/api-reference/crm-notes/get-notes-for-a-crm-company"},{"title":"Create a note on a CRM company","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/companies/{crmCompanyId}/notes","href":"/api-reference/crm-notes/create-a-note-on-a-crm-company"}]},{"group":"CRM Attachments","pages":[{"title":"List attachments for a deal, contact, or company","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/attachments","href":"/api-reference/crm-attachments/list-attachments-for-a-deal-contact-or-company"},{"title":"Attach a file to a deal, contact, or company","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/attachments","href":"/api-reference/crm-attachments/attach-a-file-to-a-deal-contact-or-company"},{"title":"Get download URL for an attachment","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/attachments/{id}/download","href":"/api-reference/crm-attachments/get-download-url-for-an-attachment"},{"title":"Delete an attachment","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/attachments/{id}","href":"/api-reference/crm-attachments/delete-an-attachment"},{"title":"Update an attachment","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/attachments/{id}","href":"/api-reference/crm-attachments/update-an-attachment"},{"title":"Get attachments for a deal","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{dealId}/attachments","href":"/api-reference/crm-attachments/get-attachments-for-a-deal"},{"title":"Attach a file to a deal","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/deals/{dealId}/attachments","href":"/api-reference/crm-attachments/attach-a-file-to-a-deal"},{"title":"Get attachments for a contact","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/contacts/{contactId}/attachments","href":"/api-reference/crm-attachments/get-attachments-for-a-contact"},{"title":"Attach a file to a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/contacts/{contactId}/attachments","href":"/api-reference/crm-attachments/attach-a-file-to-a-contact"},{"title":"Get attachments for a CRM company","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies/{crmCompanyId}/attachments","href":"/api-reference/crm-attachments/get-attachments-for-a-crm-company"},{"title":"Attach a file to a CRM company","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/companies/{crmCompanyId}/attachments","href":"/api-reference/crm-attachments/attach-a-file-to-a-crm-company"}]},{"group":"CRM Communications","pages":[{"title":"List communications for a deal, contact, or company","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/communications","href":"/api-reference/crm-communications/list-communications-for-a-deal-contact-or-company"},{"title":"Log a communication (call, email, SMS) on a deal, contact, or company","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/communications","href":"/api-reference/crm-communications/log-a-communication-call-email-sms-on-a-deal-contact-or-company"},{"title":"Delete a communication","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/communications/{id}","href":"/api-reference/crm-communications/delete-a-communication"},{"title":"Update a communication","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/communications/{id}","href":"/api-reference/crm-communications/update-a-communication"},{"title":"Get communications for a deal","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{dealId}/communications","href":"/api-reference/crm-communications/get-communications-for-a-deal"},{"title":"Log a communication on a deal","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/deals/{dealId}/communications","href":"/api-reference/crm-communications/log-a-communication-on-a-deal"},{"title":"Get communications for a contact","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/contacts/{contactId}/communications","href":"/api-reference/crm-communications/get-communications-for-a-contact"},{"title":"Log a communication on a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/contacts/{contactId}/communications","href":"/api-reference/crm-communications/log-a-communication-on-a-contact"},{"title":"Get communications for a CRM company","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies/{crmCompanyId}/communications","href":"/api-reference/crm-communications/get-communications-for-a-crm-company"},{"title":"Log a communication on a CRM company","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/companies/{crmCompanyId}/communications","href":"/api-reference/crm-communications/log-a-communication-on-a-crm-company"}]},{"group":"availability","pages":[{"title":"Get Booking Availability","href":"/api-reference/availability/get-availability"},{"title":"Post availability","deprecated":null,"version":null,"openapi":"/openapi.json post /availability","href":"/api-reference/availability/post-availability"},{"title":"Get many user's availability at once","deprecated":null,"version":null,"openapi":"/openapi.json get /availability/many","href":"/api-reference/availability/get-many-users-availability-at-once"},{"title":"Post availabilitybulk holidays","deprecated":null,"version":null,"openapi":"/openapi.json post /availability/bulk-holidays","href":"/api-reference/availability/post-availabilitybulk-holidays"},{"title":"Get availability meeting types","deprecated":null,"version":null,"openapi":"/openapi.json get /availability/{id}/meeting-types","href":"/api-reference/availability/get-availability-meeting-types"},{"title":"Post availability apply to users","deprecated":null,"version":null,"openapi":"/openapi.json post /availability/{id}/apply-to-users","href":"/api-reference/availability/post-availability-apply-to-users"},{"title":"Get availability 1","deprecated":null,"version":null,"openapi":"/openapi.json get /availability/{id}","href":"/api-reference/availability/get-availability-1"},{"title":"Delete availability","deprecated":null,"version":null,"openapi":"/openapi.json delete /availability/{id}","href":"/api-reference/availability/delete-availability"},{"title":"Patch availability","deprecated":null,"version":null,"openapi":"/openapi.json patch /availability/{id}","href":"/api-reference/availability/patch-availability"},{"title":"Post availabilitydefault","deprecated":null,"version":null,"openapi":"/openapi.json post /availability/default/{availabilityId}","href":"/api-reference/availability/post-availabilitydefault"},{"title":"Patch availability holiday exceptions","deprecated":null,"version":null,"openapi":"/openapi.json patch /availability/{id}/holiday-exceptions","href":"/api-reference/availability/patch-availability-holiday-exceptions"}]},{"group":"availability-exception","pages":[{"title":"Gets user availability exceptions","deprecated":null,"version":null,"openapi":"/openapi.json get /availability-exception/user","href":"/api-reference/availability-exception/gets-user-availability-exceptions"},{"title":"Create user availability exception","deprecated":null,"version":null,"openapi":"/openapi.json post /availability-exception/user","href":"/api-reference/availability-exception/create-user-availability-exception"},{"title":"Update user availability exception","deprecated":null,"version":null,"openapi":"/openapi.json put /availability-exception/{id}","href":"/api-reference/availability-exception/update-user-availability-exception"},{"title":"Delete availability exception","deprecated":null,"version":null,"openapi":"/openapi.json delete /availability-exception/{id}","href":"/api-reference/availability-exception/delete-availability-exception"},{"title":"Gets company availability exceptions","deprecated":null,"version":null,"openapi":"/openapi.json get /availability-exception/company","href":"/api-reference/availability-exception/gets-company-availability-exceptions"},{"title":"Create company availability exception","deprecated":null,"version":null,"openapi":"/openapi.json post /availability-exception/company","href":"/api-reference/availability-exception/create-company-availability-exception"}]},{"group":"WhatsApp V4","pages":[{"title":"Connection test","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/whatsapp/ping","href":"/api-reference/whatsapp-v4/connection-test"},{"title":"Poll for messages","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/whatsapp/messages","href":"/api-reference/whatsapp-v4/poll-for-messages"},{"title":"Send a WhatsApp message","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/whatsapp/messages","href":"/api-reference/whatsapp-v4/send-a-whatsapp-message"},{"title":"List WhatsApp business senders","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/whatsapp/senders","href":"/api-reference/whatsapp-v4/list-whatsapp-business-senders"},{"title":"List message templates","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/whatsapp/templates","href":"/api-reference/whatsapp-v4/list-message-templates"},{"title":"List conversations","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/whatsapp/conversations","href":"/api-reference/whatsapp-v4/list-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/whatsapp/conversations/{id}","href":"/api-reference/whatsapp-v4/get-a-conversation"},{"title":"List messages in a conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/whatsapp/conversations/{id}/messages","href":"/api-reference/whatsapp-v4/list-messages-in-a-conversation"}]},{"group":"Signatures V4","pages":[{"title":"Connection test","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/signatures/ping","href":"/api-reference/signatures-v4/connection-test"},{"title":"This month’s signature usage","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/signatures/usage","href":"/api-reference/signatures-v4/this-month’s-signature-usage"},{"title":"List signature requests","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/signatures","href":"/api-reference/signatures-v4/list-signature-requests"},{"title":"Create a signature request","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/signatures","href":"/api-reference/signatures-v4/create-a-signature-request"},{"title":"Resend a signer invitation","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/signatures/{id}/signers/{signerId}/send","href":"/api-reference/signatures-v4/resend-a-signer-invitation"},{"title":"Get a signature request","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/signatures/{id}","href":"/api-reference/signatures-v4/get-a-signature-request"},{"title":"Cancel a signature request","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/signatures/{id}","href":"/api-reference/signatures-v4/cancel-a-signature-request"},{"title":"Download the signed document","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/signatures/{id}/document","href":"/api-reference/signatures-v4/download-the-signed-document"}]},{"group":"Data Fields","pages":[{"title":"Upload an option-card image; returns a stable public URL to store in\n`options[].image`. Replaces the base64 data-URL workaround that bloated\nthe options jsonb.","deprecated":null,"version":null,"openapi":"/openapi.json post /data-field/option-image","href":"/api-reference/data-fields/upload-an-option-card-image;-returns-a-stable-public-url-to-store-in`options[]image`-replaces-the-base64-data-url-workaround-that-bloatedthe-options-jsonb"},{"title":"Get all data fields","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /data-field","href":"/api-reference/data-fields/get-all-data-fields"},{"title":"Add a new data field","deprecated":null,"version":null,"openapi":"/openapi.json post /data-field","href":"/api-reference/data-fields/add-a-new-data-field"},{"title":"Set the order the fields are read in. Declared before `PATCH :fieldId` so\nNest does not resolve `reorder` as a field id.","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json patch /data-field/reorder","href":"/api-reference/data-fields/set-the-order-the-fields-are-read-in-declared-before-`patch-:fieldid`-sonest-does-not-resolve-`reorder`-as-a-field-id"},{"title":"Remove a data field","deprecated":null,"version":null,"openapi":"/openapi.json delete /data-field/{fieldId}","href":"/api-reference/data-fields/remove-a-data-field"},{"title":"Update data field","deprecated":null,"version":null,"openapi":"/openapi.json patch /data-field/{fieldId}","href":"/api-reference/data-fields/update-data-field"},{"title":"List every form (within the user's company) that currently references this\nDataField. Used by the field editor to surface \"Used in N forms\" so users\nunderstand the blast radius of an edit.","deprecated":null,"version":null,"openapi":"/openapi.json get /data-field/{fieldId}/usage","href":"/api-reference/data-fields/list-every-form-within-the-users-company-that-currently-references-thisdatafield-used-by-the-field-editor-to-surface-\"used-in-n-forms\"-so-usersunderstand-the-blast-radius-of-an-edit"}]},{"group":"space","pages":[{"title":"Get space","deprecated":null,"version":null,"openapi":"/openapi.json get /space","href":"/api-reference/space/get-space"},{"title":"Post space","deprecated":null,"version":null,"openapi":"/openapi.json post /space","href":"/api-reference/space/post-space"},{"title":"Create a portal with Mira from the operator's brief + client context.\n Generates a tailored layout via the EU gateway; falls back to the\n localized client-portal preset when the gateway is off or the model\n returns nothing usable, so the client context always lands.","deprecated":null,"version":null,"openapi":"/openapi.json get /space/templates","href":"/api-reference/space/create-a-portal-with-mira-from-the-operators-brief-+-client-context-generates-a-tailored-layout-via-the-eu-gateway;-falls-back-to-the-localized-client-portal-preset-when-the-gateway-is-off-or-the-model-returns-nothing-usable-so-the-client-context-always-lands"},{"title":"A working portal from a template, for a client. One transactional copy:\nsections, blocks and content references, progress cleared, the previous\nclient's name and brand swapped for the new one's.","deprecated":null,"version":null,"openapi":"/openapi.json post /space/from-template","href":"/api-reference/space/a-working-portal-from-a-template-for-a-client-one-transactional-copy:sections-blocks-and-content-references-progress-cleared-the-previousclients-name-and-brand-swapped-for-the-new-ones"},{"title":"Get space 1","deprecated":null,"version":null,"openapi":"/openapi.json get /space/{spaceId}","href":"/api-reference/space/get-space-1"},{"title":"Delete space","deprecated":null,"version":null,"openapi":"/openapi.json delete /space/{spaceId}","href":"/api-reference/space/delete-space"},{"title":"Patch space","deprecated":null,"version":null,"openapi":"/openapi.json patch /space/{spaceId}","href":"/api-reference/space/patch-space"},{"title":"Post space publish","deprecated":null,"version":null,"openapi":"/openapi.json post /space/{spaceId}/publish","href":"/api-reference/space/post-space-publish"},{"title":"A same-client copy of a space, \"(Copy)\" suffixed.","deprecated":null,"version":null,"openapi":"/openapi.json post /space/{spaceId}/duplicate","href":"/api-reference/space/a-same-client-copy-of-a-space-\"copy\"-suffixed"},{"title":"Snapshot a space as a reusable template (listed under GET /space/templates).","deprecated":null,"version":null,"openapi":"/openapi.json post /space/{spaceId}/save-as-template","href":"/api-reference/space/snapshot-a-space-as-a-reusable-template-listed-under-get-spacetemplates"},{"title":"Post space section","deprecated":null,"version":null,"openapi":"/openapi.json post /space/{spaceId}/section","href":"/api-reference/space/post-space-section"},{"title":"Insert a saved section template, with all its blocks, in one go.","deprecated":null,"version":null,"openapi":"/openapi.json post /space/{spaceId}/section-from-template","href":"/api-reference/space/insert-a-saved-section-template-with-all-its-blocks-in-one-go"},{"title":"Delete space section","deprecated":null,"version":null,"openapi":"/openapi.json delete /space/{spaceId}/section/{sectionId}","href":"/api-reference/space/delete-space-section"},{"title":"Patch space section","deprecated":null,"version":null,"openapi":"/openapi.json patch /space/{spaceId}/section/{sectionId}","href":"/api-reference/space/patch-space-section"},{"title":"Post space section block","deprecated":null,"version":null,"openapi":"/openapi.json post /space/{spaceId}/section/{sectionId}/block","href":"/api-reference/space/post-space-section-block"},{"title":"Delete space section block","deprecated":null,"version":null,"openapi":"/openapi.json delete /space/{spaceId}/section/{sectionId}/block/{blockId}","href":"/api-reference/space/delete-space-section-block"},{"title":"Patch space section block","deprecated":null,"version":null,"openapi":"/openapi.json patch /space/{spaceId}/section/{sectionId}/block/{blockId}","href":"/api-reference/space/patch-space-section-block"},{"title":"Get space link","deprecated":null,"version":null,"openapi":"/openapi.json get /space/{spaceId}/link","href":"/api-reference/space/get-space-link"},{"title":"Post space link","deprecated":null,"version":null,"openapi":"/openapi.json post /space/{spaceId}/link","href":"/api-reference/space/post-space-link"},{"title":"Delete space link","deprecated":null,"version":null,"openapi":"/openapi.json delete /space/{spaceId}/link/{linkId}","href":"/api-reference/space/delete-space-link"},{"title":"Patch space link","deprecated":null,"version":null,"openapi":"/openapi.json patch /space/{spaceId}/link/{linkId}","href":"/api-reference/space/patch-space-link"},{"title":"Every form block in the space and the submissions that came in through\n it: whether the viewer handed it in, when, and the answers.","deprecated":null,"version":null,"openapi":"/openapi.json get /space/{spaceId}/form-status","href":"/api-reference/space/every-form-block-in-the-space-and-the-submissions-that-came-in-through-it:-whether-the-viewer-handed-it-in-when-and-the-answers"},{"title":"Get space uploads","deprecated":null,"version":null,"openapi":"/openapi.json get /space/{spaceId}/uploads","href":"/api-reference/space/get-space-uploads"},{"title":"Get space uploads download","deprecated":null,"version":null,"openapi":"/openapi.json get /space/{spaceId}/uploads/{uploadId}/download","href":"/api-reference/space/get-space-uploads-download"},{"title":"Get space people","deprecated":null,"version":null,"openapi":"/openapi.json get /space/{spaceId}/people","href":"/api-reference/space/get-space-people"},{"title":"Post space people","deprecated":null,"version":null,"openapi":"/openapi.json post /space/{spaceId}/people","href":"/api-reference/space/post-space-people"},{"title":"Delete space people","deprecated":null,"version":null,"openapi":"/openapi.json delete /space/{spaceId}/people/{inviteId}","href":"/api-reference/space/delete-space-people"},{"title":"Get space section template","deprecated":null,"version":null,"openapi":"/openapi.json get /space-section-template","href":"/api-reference/space/get-space-section-template"},{"title":"Post space section template","deprecated":null,"version":null,"openapi":"/openapi.json post /space-section-template","href":"/api-reference/space/post-space-section-template"},{"title":"Snapshot a live section of one of your spaces as a reusable template.","deprecated":null,"version":null,"openapi":"/openapi.json post /space-section-template/from-section","href":"/api-reference/space/snapshot-a-live-section-of-one-of-your-spaces-as-a-reusable-template"},{"title":"Delete space section template","deprecated":null,"version":null,"openapi":"/openapi.json delete /space-section-template/{templateId}","href":"/api-reference/space/delete-space-section-template"}]},{"group":"Documents","pages":[{"title":"List pages and spreadsheets","deprecated":null,"version":null,"openapi":"/openapi.json get /documents","href":"/api-reference/documents/list-pages-and-spreadsheets"},{"title":"Create a page or spreadsheet","deprecated":null,"version":null,"openapi":"/openapi.json post /documents","href":"/api-reference/documents/create-a-page-or-spreadsheet"},{"title":"Load a document with its content","deprecated":null,"version":null,"openapi":"/openapi.json get /documents/{id}","href":"/api-reference/documents/load-a-document-with-its-content"},{"title":"Delete a document","deprecated":null,"version":null,"openapi":"/openapi.json delete /documents/{id}","href":"/api-reference/documents/delete-a-document"},{"title":"Save document content and/or title","deprecated":null,"version":null,"openapi":"/openapi.json patch /documents/{id}","href":"/api-reference/documents/save-document-content-andor-title"}]},{"group":"Invoicing Sellers","pages":[{"title":"Get invoicingseller profiles","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/seller-profiles","href":"/api-reference/invoicing-sellers/get-invoicingseller-profiles"},{"title":"Post invoicingseller profiles","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/seller-profiles","href":"/api-reference/invoicing-sellers/post-invoicingseller-profiles"},{"title":"Get invoicingseller profiles 1","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/seller-profiles/{id}","href":"/api-reference/invoicing-sellers/get-invoicingseller-profiles-1"},{"title":"Delete invoicingseller profiles","deprecated":null,"version":null,"openapi":"/openapi.json delete /invoicing/seller-profiles/{id}","href":"/api-reference/invoicing-sellers/delete-invoicingseller-profiles"},{"title":"Patch invoicingseller profiles","deprecated":null,"version":null,"openapi":"/openapi.json patch /invoicing/seller-profiles/{id}","href":"/api-reference/invoicing-sellers/patch-invoicingseller-profiles"},{"title":"Post invoicingseller profiles archive","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/seller-profiles/{id}/archive","href":"/api-reference/invoicing-sellers/post-invoicingseller-profiles-archive"},{"title":"Post invoicingseller profiles restore","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/seller-profiles/{id}/restore","href":"/api-reference/invoicing-sellers/post-invoicingseller-profiles-restore"}]},{"group":"Invoicing Branches","pages":[{"title":"Get invoicingbranches","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/branches","href":"/api-reference/invoicing-branches/get-invoicingbranches"},{"title":"Post invoicingbranches","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/branches","href":"/api-reference/invoicing-branches/post-invoicingbranches"},{"title":"Get invoicingbranches 1","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/branches/{id}","href":"/api-reference/invoicing-branches/get-invoicingbranches-1"},{"title":"Delete invoicingbranches","deprecated":null,"version":null,"openapi":"/openapi.json delete /invoicing/branches/{id}","href":"/api-reference/invoicing-branches/delete-invoicingbranches"},{"title":"Patch invoicingbranches","deprecated":null,"version":null,"openapi":"/openapi.json patch /invoicing/branches/{id}","href":"/api-reference/invoicing-branches/patch-invoicingbranches"},{"title":"Post invoicingbranches archive","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/branches/{id}/archive","href":"/api-reference/invoicing-branches/post-invoicingbranches-archive"},{"title":"Post invoicingbranches restore","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/branches/{id}/restore","href":"/api-reference/invoicing-branches/post-invoicingbranches-restore"}]},{"group":"Invoicing Products","pages":[{"title":"Get invoicingproducts","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/products","href":"/api-reference/invoicing-products/get-invoicingproducts"},{"title":"Post invoicingproducts","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/products","href":"/api-reference/invoicing-products/post-invoicingproducts"},{"title":"Get invoicingproducts 1","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/products/{id}","href":"/api-reference/invoicing-products/get-invoicingproducts-1"},{"title":"Delete invoicingproducts","deprecated":null,"version":null,"openapi":"/openapi.json delete /invoicing/products/{id}","href":"/api-reference/invoicing-products/delete-invoicingproducts"},{"title":"Patch invoicingproducts","deprecated":null,"version":null,"openapi":"/openapi.json patch /invoicing/products/{id}","href":"/api-reference/invoicing-products/patch-invoicingproducts"}]},{"group":"Invoicing Settings","pages":[{"title":"Get invoicingsettings","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/settings","href":"/api-reference/invoicing-settings/get-invoicingsettings"},{"title":"Put invoicingsettings","deprecated":null,"version":null,"openapi":"/openapi.json put /invoicing/settings","href":"/api-reference/invoicing-settings/put-invoicingsettings"},{"title":"Get invoicingbank accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/bank-accounts","href":"/api-reference/invoicing-settings/get-invoicingbank-accounts"},{"title":"Post invoicingbank accounts","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/bank-accounts","href":"/api-reference/invoicing-settings/post-invoicingbank-accounts"},{"title":"Delete invoicingbank accounts","deprecated":null,"version":null,"openapi":"/openapi.json delete /invoicing/bank-accounts/{id}","href":"/api-reference/invoicing-settings/delete-invoicingbank-accounts"},{"title":"Patch invoicingbank accounts","deprecated":null,"version":null,"openapi":"/openapi.json patch /invoicing/bank-accounts/{id}","href":"/api-reference/invoicing-settings/patch-invoicingbank-accounts"},{"title":"","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/number-ranges","href":"/api-reference/invoicing-settings/get-invoicingnumber-ranges"},{"title":"","deprecated":null,"version":null,"openapi":"/openapi.json put /invoicing/number-ranges/{kind}","href":"/api-reference/invoicing-settings/put-invoicingnumber-ranges"}]},{"group":"Invoicing Recurring","pages":[{"title":"Buyer fields for an invoice, taken from a CRM company","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/buyer-prefill/company/{crmCompanyId}","href":"/api-reference/invoicing-recurring/buyer-fields-for-an-invoice-taken-from-a-crm-company"},{"title":"Contacts of a CRM company, for the buyer picker","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/buyer-prefill/company/{crmCompanyId}/contacts","href":"/api-reference/invoicing-recurring/contacts-of-a-crm-company-for-the-buyer-picker"},{"title":"Which completed meetings a customer had in the period, priced as lines","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/billing-runs/preview","href":"/api-reference/invoicing-recurring/which-completed-meetings-a-customer-had-in-the-period-priced-as-lines"},{"title":"Draft invoice over those meetings; opens in the editor for review","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/billing-runs","href":"/api-reference/invoicing-recurring/draft-invoice-over-those-meetings;-opens-in-the-editor-for-review"},{"title":"ZIP download: EXTF Buchungsstapel CSV + document PDFs of the period","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/datev/export","href":"/api-reference/invoicing-recurring/zip-download:-extf-buchungsstapel-csv-+-document-pdfs-of-the-period"},{"title":"One-click Steuerberater handoff: email the export ZIP to the advisor.\nThrottled hard — this is a monthly action that builds and mails a whole\nperiod's documents, so a loop here is expensive on both sides.","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/datev/send","href":"/api-reference/invoicing-recurring/one-click-steuerberater-handoff:-email-the-export-zip-to-the-advisorthrottled-hard-—-this-is-a-monthly-action-that-builds-and-mails-a-wholeperiods-documents-so-a-loop-here-is-expensive-on-both-sides"},{"title":"Get invoicingrecurring","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/recurring","href":"/api-reference/invoicing-recurring/get-invoicingrecurring"},{"title":"Post invoicingrecurring","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/recurring","href":"/api-reference/invoicing-recurring/post-invoicingrecurring"},{"title":"Get invoicingrecurring 1","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/recurring/{id}","href":"/api-reference/invoicing-recurring/get-invoicingrecurring-1"},{"title":"Delete invoicingrecurring","deprecated":null,"version":null,"openapi":"/openapi.json delete /invoicing/recurring/{id}","href":"/api-reference/invoicing-recurring/delete-invoicingrecurring"},{"title":"Patch invoicingrecurring","deprecated":null,"version":null,"openapi":"/openapi.json patch /invoicing/recurring/{id}","href":"/api-reference/invoicing-recurring/patch-invoicingrecurring"}]},{"group":"Invoicing Documents","pages":[{"title":"Get invoicingdocuments","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/documents","href":"/api-reference/invoicing-documents/get-invoicingdocuments"},{"title":"Post invoicingdocuments","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents","href":"/api-reference/invoicing-documents/post-invoicingdocuments"},{"title":"Get invoicingdocuments 1","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/documents/{id}","href":"/api-reference/invoicing-documents/get-invoicingdocuments-1"},{"title":"Delete invoicingdocuments","deprecated":null,"version":null,"openapi":"/openapi.json delete /invoicing/documents/{id}","href":"/api-reference/invoicing-documents/delete-invoicingdocuments"},{"title":"Patch invoicingdocuments","deprecated":null,"version":null,"openapi":"/openapi.json patch /invoicing/documents/{id}","href":"/api-reference/invoicing-documents/patch-invoicingdocuments"},{"title":"Post invoicingdocuments finalize","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/finalize","href":"/api-reference/invoicing-documents/post-invoicingdocuments-finalize"},{"title":"Post invoicingdocuments send","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/send","href":"/api-reference/invoicing-documents/post-invoicingdocuments-send"},{"title":"WhatsApp template delivery; the message links to the hosted pay page","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/send-whatsapp","href":"/api-reference/invoicing-documents/whatsapp-template-delivery;-the-message-links-to-the-hosted-pay-page"},{"title":"Post invoicingdocuments duplicate","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/duplicate","href":"/api-reference/invoicing-documents/post-invoicingdocuments-duplicate"},{"title":"Post invoicingdocuments convert to invoice","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/convert-to-invoice","href":"/api-reference/invoicing-documents/post-invoicingdocuments-convert-to-invoice"},{"title":"Post invoicingdocuments offer status","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/offer-status","href":"/api-reference/invoicing-documents/post-invoicingdocuments-offer-status"},{"title":"Post invoicingdocuments cancel","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/cancel","href":"/api-reference/invoicing-documents/post-invoicingdocuments-cancel"},{"title":"Get invoicingdocuments events","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/documents/{id}/events","href":"/api-reference/invoicing-documents/get-invoicingdocuments-events"},{"title":"Get invoicingdocuments preview","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/documents/{id}/preview","href":"/api-reference/invoicing-documents/get-invoicingdocuments-preview"},{"title":"Get invoicingdocuments download","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/documents/{id}/download/{type}","href":"/api-reference/invoicing-documents/get-invoicingdocuments-download"},{"title":"Get invoicingdocuments payments","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/documents/{id}/payments","href":"/api-reference/invoicing-documents/get-invoicingdocuments-payments"},{"title":"Post invoicingdocuments payments","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/payments","href":"/api-reference/invoicing-documents/post-invoicingdocuments-payments"},{"title":"Delete invoicingdocuments payments","deprecated":null,"version":null,"openapi":"/openapi.json delete /invoicing/documents/{id}/payments/{paymentId}","href":"/api-reference/invoicing-documents/delete-invoicingdocuments-payments"},{"title":"Hosted pay-page URL for finalized invoices (copy button in the UI)","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/documents/{id}/payment-link","href":"/api-reference/invoicing-documents/hosted-pay-page-url-for-finalized-invoices-copy-button-in-the-ui"},{"title":"Exclude/include this invoice from dunning auto-send","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/dunning-pause","href":"/api-reference/invoicing-documents/excludeinclude-this-invoice-from-dunning-auto-send"},{"title":"Invoice → editable Gutschrift draft over all or selected lines","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/credit-note","href":"/api-reference/invoicing-documents/invoice-→-editable-gutschrift-draft-over-all-or-selected-lines"},{"title":"How much of an invoice is already credited, and what is still open","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/documents/{id}/credit-notes","href":"/api-reference/invoicing-documents/how-much-of-an-invoice-is-already-credited-and-what-is-still-open"},{"title":"Gutschrift draft → issued document + receivable offset","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/credit-notes/{id}/issue","href":"/api-reference/invoicing-documents/gutschrift-draft-→-issued-document-+-receivable-offset"},{"title":"","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/documents/{id}/dunning/preview","href":"/api-reference/invoicing-documents/get-invoicingdocuments-dunningpreview"},{"title":"Sends mail on the company letterhead; throttled like the other send paths.","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/dunning/send","href":"/api-reference/invoicing-documents/sends-mail-on-the-company-letterhead;-throttled-like-the-other-send-paths"}]},{"group":"Partner API","pages":[{"title":"List your customer workspaces","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/partner/customers","href":"/api-reference/partner-api/list-your-customer-workspaces"},{"title":"Create a customer workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/partner/customers","href":"/api-reference/partner-api/create-a-customer-workspace"},{"title":"Get one customer workspace","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/partner/customers/{companyId}","href":"/api-reference/partner-api/get-one-customer-workspace"},{"title":"Update a customer workspace","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/partner/customers/{companyId}","href":"/api-reference/partner-api/update-a-customer-workspace"},{"title":"Get a workspace token","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/partner/customers/{companyId}/token","href":"/api-reference/partner-api/get-a-workspace-token"},{"title":"List the users of a customer workspace","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/partner/customers/{companyId}/users","href":"/api-reference/partner-api/list-the-users-of-a-customer-workspace"},{"title":"Invite users to a customer workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/partner/customers/{companyId}/users","href":"/api-reference/partner-api/invite-users-to-a-customer-workspace"},{"title":"Remove a user from a customer workspace","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/partner/customers/{companyId}/users/{userId}","href":"/api-reference/partner-api/remove-a-user-from-a-customer-workspace"},{"title":"Billing summary","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/partner/billing/summary","href":"/api-reference/partner-api/billing-summary"},{"title":"List Refer commission entries","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/partner/commissions","href":"/api-reference/partner-api/list-refer-commission-entries"},{"title":"Commission totals: held, available, paid","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/partner/commissions/summary","href":"/api-reference/partner-api/commission-totals:-held-available-paid"}]},{"group":"CRM Email Sync","pages":[{"title":"Get synced emails for a CRM contact","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/contacts/{contactId}/emails","href":"/api-reference/crm-email-sync/get-synced-emails-for-a-crm-contact"},{"title":"Get synced emails for a CRM deal","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{dealId}/emails","href":"/api-reference/crm-email-sync/get-synced-emails-for-a-crm-deal"},{"title":"Fetch full email body on-demand from provider","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/emails/{id}/body","href":"/api-reference/crm-email-sync/fetch-full-email-body-on-demand-from-provider"},{"title":"Whether the current user can send from their own mailbox","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/emails/send-capability","href":"/api-reference/crm-email-sync/whether-the-current-user-can-send-from-their-own-mailbox"}]},{"group":"Meeting Type V4","pages":[{"title":"Get meeting types","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/meeting-type","href":"/api-reference/meeting-type-v4/get-meeting-types"},{"title":"Create meeting type","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/meeting-type","href":"/api-reference/meeting-type-v4/create-meeting-type"},{"title":"Get meeting type information","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/meeting-type/{id}","href":"/api-reference/meeting-type-v4/get-meeting-type-information"},{"title":"Delete meeting type","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/meeting-type/{id}","href":"/api-reference/meeting-type-v4/delete-meeting-type"},{"title":"Update meeting type","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/meeting-type/{id}","href":"/api-reference/meeting-type-v4/update-meeting-type"}]},{"group":"Booking Availability V4","pages":[{"title":"Get booking availability for a meeting type","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-availability","href":"/api-reference/booking-availability-v4/get-booking-availability-for-a-meeting-type"},{"title":"Get user availability for a specific timeframe","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-availability/user/{id}/timeframe","href":"/api-reference/booking-availability-v4/get-user-availability-for-a-specific-timeframe"}]},{"group":"Queue V4","pages":[{"title":"Update queue for a meeting type","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/queue/meeting-type/{meetingTypeId}","href":"/api-reference/queue-v4/update-queue-for-a-meeting-type"},{"title":"Get all queues for a workspace","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/queue/workspace/{workspaceId}","href":"/api-reference/queue-v4/get-all-queues-for-a-workspace"},{"title":"Get all queues for a company","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/queue/company","href":"/api-reference/queue-v4/get-all-queues-for-a-company"},{"title":"Get queue by ID","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/queue/{queueId}","href":"/api-reference/queue-v4/get-queue-by-id"},{"title":"Get next available hosts from queue","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/queue/{queueId}/next","href":"/api-reference/queue-v4/get-next-available-hosts-from-queue"}]},{"group":"Queue User Group V4","pages":[{"title":"Create a new user group","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/queue-user-group","href":"/api-reference/queue-user-group-v4/create-a-new-user-group"},{"title":"Delete a user group","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/queue-user-group/{groupId}","href":"/api-reference/queue-user-group-v4/delete-a-user-group"},{"title":"Update an existing user group","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/queue-user-group/{groupId}","href":"/api-reference/queue-user-group-v4/update-an-existing-user-group"}]},{"group":"Meeting Type Template V4","pages":[{"title":"Create a new meeting type template","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/meeting-type-template/create","href":"/api-reference/meeting-type-template-v4/create-a-new-meeting-type-template"},{"title":"Assign host to meeting type template","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/meeting-type-template/assign/{templateId}","href":"/api-reference/meeting-type-template-v4/assign-host-to-meeting-type-template"},{"title":"Assign multiple hosts to meeting type template","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/meeting-type-template/assign-bulk/{templateId}","href":"/api-reference/meeting-type-template-v4/assign-multiple-hosts-to-meeting-type-template"},{"title":"Unassign host from meeting type template","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/meeting-type-template/unassign/{templateId}","href":"/api-reference/meeting-type-template-v4/unassign-host-from-meeting-type-template"},{"title":"Get all meeting type templates for user","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/meeting-type-template/all","href":"/api-reference/meeting-type-template-v4/get-all-meeting-type-templates-for-user"},{"title":"Get meeting type template by ID","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/meeting-type-template/{id}","href":"/api-reference/meeting-type-template-v4/get-meeting-type-template-by-id"},{"title":"Delete a meeting type template","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/meeting-type-template/{id}","href":"/api-reference/meeting-type-template-v4/delete-a-meeting-type-template"},{"title":"Update a meeting type template","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/meeting-type-template/{id}","href":"/api-reference/meeting-type-template-v4/update-a-meeting-type-template"},{"title":"Get meeting types created from this template","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/meeting-type-template/users/{templateId}","href":"/api-reference/meeting-type-template-v4/get-meeting-types-created-from-this-template"},{"title":"Assign team template to workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/meeting-type-template/assign-workspace/{templateId}","href":"/api-reference/meeting-type-template-v4/assign-team-template-to-workspace"},{"title":"Get workspaces assigned to this template","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/meeting-type-template/workspaces/{templateId}","href":"/api-reference/meeting-type-template-v4/get-workspaces-assigned-to-this-template"}]},{"group":"One Time Booking Link V4","pages":[{"title":"Create a one-time booking link for a meeting type","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/one-time-booking-link/create/{meetingTypeId}","href":"/api-reference/one-time-booking-link-v4/create-a-one-time-booking-link-for-a-meeting-type"}]},{"group":"Provisional Booking V4","pages":[{"title":"Get paginated provisional bookings","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/provisional-booking/paginated","href":"/api-reference/provisional-booking-v4/get-paginated-provisional-bookings"},{"title":"Delete provisional booking","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/provisional-booking/{id}","href":"/api-reference/provisional-booking-v4/delete-provisional-booking"},{"title":"Decline provisional booking","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/provisional-booking/{id}/decline","href":"/api-reference/provisional-booking-v4/decline-provisional-booking"}]},{"group":"Handoff V4","pages":[{"title":"Handoff appointment to another user or queue","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/handoff/appointment","href":"/api-reference/handoff-v4/handoff-appointment-to-another-user-or-queue"},{"title":"Get available handoff options","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/handoff/available-handoffs","href":"/api-reference/handoff-v4/get-available-handoff-options"},{"title":"Bulk handoff appointments","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/handoff/bulk","href":"/api-reference/handoff-v4/bulk-handoff-appointments"}]},{"group":"Booking Link V4","pages":[{"title":"Create a group booking link","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/booking-link/group","href":"/api-reference/booking-link-v4/create-a-group-booking-link"},{"title":"Delete a group booking link","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/booking-link/group/{groupBookingLinkId}","href":"/api-reference/booking-link-v4/delete-a-group-booking-link"},{"title":"Update a group booking link","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/booking-link/group/{groupBookingLinkId}","href":"/api-reference/booking-link-v4/update-a-group-booking-link"},{"title":"Get group booking links of a workspace","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-link/group/workspace/{workspaceId}","href":"/api-reference/booking-link-v4/get-group-booking-links-of-a-workspace"},{"title":"Get booking links for specified workspace or user workspace","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-link","href":"/api-reference/booking-link-v4/get-booking-links-for-specified-workspace-or-user-workspace"},{"title":"Get all booking links with scopes","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-link/all","href":"/api-reference/booking-link-v4/get-all-booking-links-with-scopes"},{"title":"Get meeting types assigned to requesters personal booking link","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-link/personal-link/assigned","href":"/api-reference/booking-link-v4/get-meeting-types-assigned-to-requesters-personal-booking-link"},{"title":"Get personal booking link page data","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-link/personal-link/{companySlug}/{userSlug}","href":"/api-reference/booking-link-v4/get-personal-booking-link-page-data"},{"title":"Get company booking link page data","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-link/company/{companySlug}","href":"/api-reference/booking-link-v4/get-company-booking-link-page-data"},{"title":"Get a link for personal page","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-link/personal-page/link","href":"/api-reference/booking-link-v4/get-a-link-for-personal-page"},{"title":"Get personal page data","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-link/personal-page/v2/{userSlug}","href":"/api-reference/booking-link-v4/get-personal-page-data"},{"title":"Get booking link for specified meeting type","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-link/user/{userId}/meetingType/{meetingTypeId}","href":"/api-reference/booking-link-v4/get-booking-link-for-specified-meeting-type"}]},{"group":"Booking V4","pages":[{"title":"Confirm appointment cancellation","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/booking/confirm/cancel/{appointmentId}/{secret}","href":"/api-reference/booking-v4/confirm-appointment-cancellation"},{"title":"Create appointment booking","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/booking","href":"/api-reference/booking-v4/create-appointment-booking"}]},{"group":"appointment","pages":[{"title":"Draft a follow-up email from a meeting-s notes","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/appointment/{appointmentId}/follow-up-draft","href":"/api-reference/appointment/draft-a-follow-up-email-from-a-meeting-s-notes"},{"title":"Make this meeting-s recap readable by link","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/appointment/{appointmentId}/recap/share","href":"/api-reference/appointment/make-this-meeting-s-recap-readable-by-link"},{"title":"Revoke the recap link","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/appointment/{appointmentId}/recap/unshare","href":"/api-reference/appointment/revoke-the-recap-link"},{"title":"Email a meeting's notes to a chosen address","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/meeting-transcript/email","href":"/api-reference/appointment/email-a-meetings-notes-to-a-chosen-address"}]},{"group":"Attendee V4","pages":[{"title":"Mark attendee as no-show","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/attendee/no-show/{attendeeId}","href":"/api-reference/attendee-v4/mark-attendee-as-no-show"},{"title":"Send quick email to attendee","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/attendee/quick-mail","href":"/api-reference/attendee-v4/send-quick-email-to-attendee"},{"title":"Update attendee notes","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/attendee/{attendeeId}/notes","href":"/api-reference/attendee-v4/update-attendee-notes"}]},{"group":"Appointment V4","pages":[{"title":"Get public appointment details","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/appointment/public/{appointmentId}","href":"/api-reference/appointment-v4/get-public-appointment-details"},{"title":"Get paginated appointments","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/appointment/paginated","href":"/api-reference/appointment-v4/get-paginated-appointments"},{"title":"Delete appointment","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/appointment/{appointmentId}","href":"/api-reference/appointment-v4/delete-appointment"},{"title":"Get today's appointments","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/appointment/today","href":"/api-reference/appointment-v4/get-todays-appointments"},{"title":"Get current appointment","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/appointment/current","href":"/api-reference/appointment-v4/get-current-appointment"},{"title":"Get appointment by ID","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/appointment/{id}","href":"/api-reference/appointment-v4/get-appointment-by-id"},{"title":"Remove guest email from appointment","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/appointment/{appointmentId}/guest","href":"/api-reference/appointment-v4/remove-guest-email-from-appointment"},{"title":"Add guest emails to appointment","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/appointment/{appointmentId}/guest","href":"/api-reference/appointment-v4/add-guest-emails-to-appointment"},{"title":"Update appointment notes","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/appointment/{appointmentId}/notes","href":"/api-reference/appointment-v4/update-appointment-notes"},{"title":"Update meeting transcription and summary","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/appointment/{appointmentId}/transcription","href":"/api-reference/appointment-v4/update-meeting-transcription-and-summary"},{"title":"Cancel an appointment","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/appointment/{id}/cancel","href":"/api-reference/appointment-v4/cancel-an-appointment"},{"title":"Reschedule an appointment","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/appointment/{id}/reschedule","href":"/api-reference/appointment-v4/reschedule-an-appointment"}]},{"group":"Attendee Pending V4","pages":[{"title":"Get pending attendees","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/attendee/pending","href":"/api-reference/attendee-pending-v4/get-pending-attendees"},{"title":"Create pending attendee","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/attendee/pending","href":"/api-reference/attendee-pending-v4/create-pending-attendee"},{"title":"Update pending attendee","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/attendee/pending/{id}","href":"/api-reference/attendee-pending-v4/update-pending-attendee"}]},{"group":"Personal Page V4","pages":[{"title":"Get personal page of the requesting user","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/personal-page/me","href":"/api-reference/personal-page-v4/get-personal-page-of-the-requesting-user"},{"title":"Update personal page of the requesting user","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/personal-page/me","href":"/api-reference/personal-page-v4/update-personal-page-of-the-requesting-user"},{"title":"Get personal page by user ID (admin only)","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/personal-page/{id}","href":"/api-reference/personal-page-v4/get-personal-page-by-user-id-admin-only"},{"title":"Update personal page by user ID (admin only)","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/personal-page/{id}","href":"/api-reference/personal-page-v4/update-personal-page-by-user-id-admin-only"},{"title":"Update personal page header picture","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/personal-page/header-picture","href":"/api-reference/personal-page-v4/update-personal-page-header-picture"}]},{"group":"User V4","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/user","href":"/api-reference/user-v4/list-users"},{"title":"Create platform user","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/user","href":"/api-reference/user-v4/create-platform-user"},{"title":"Get current user information","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/user/me","href":"/api-reference/user-v4/get-current-user-information"},{"title":"Get user information","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/user/{id}","href":"/api-reference/user-v4/get-user-information"},{"title":"Delete a user","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/user/{id}","href":"/api-reference/user-v4/delete-a-user"},{"title":"Update platform user","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/user/{id}","href":"/api-reference/user-v4/update-platform-user"},{"title":"Update user calendar sync provider","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/user/{id}/calendar-sync","href":"/api-reference/user-v4/update-user-calendar-sync-provider"}]},{"group":"Calendar Auth V4","pages":[{"title":"Get OAuth authorization URL","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/calendar-connections/auth/{provider}/url","href":"/api-reference/calendar-auth-v4/get-oauth-authorization-url"},{"title":"OAuth callback handler","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/calendar-connections/auth/{provider}/callback","href":"/api-reference/calendar-auth-v4/oauth-callback-handler"}]},{"group":"Calendar Connections V4","pages":[{"title":"List calendar connections","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/calendar-connections/connections","href":"/api-reference/calendar-connections-v4/list-calendar-connections"},{"title":"Delete calendar connection","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/calendar-connections/connections/{connectionId}","href":"/api-reference/calendar-connections-v4/delete-calendar-connection"},{"title":"Update calendar connection","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/calendar-connections/connections/{connectionId}","href":"/api-reference/calendar-connections-v4/update-calendar-connection"},{"title":"Set connection as primary","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/calendar-connections/connections/{connectionId}/set-primary","href":"/api-reference/calendar-connections-v4/set-connection-as-primary"},{"title":"Get connection calendars","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/calendar-connections/connections/{connectionId}/calendars","href":"/api-reference/calendar-connections-v4/get-connection-calendars"}]}]}]},"basePath":"","title":"Add a new data field - meetergo","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CxAy5y67.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}