> ## Documentation Index > Fetch the complete documentation index at: https://developer.meetergo.com/llms.txt > Use this file to discover all available pages before exploring further. # Add a new data field ## OpenAPI ````yaml /openapi.json post /data-field openapi: 3.0.0 info: title: meetergo Platform API description: >- Scheduling, CRM and invoicing in one API: create users, manage availability and bookings, connect calendars, keep contacts and deals in sync, and take an offer through to a paid invoice. version: 3.274.0 contact: {} termsOfService: https://www.meetergo.com/tos/ servers: [] security: [] tags: - name: User V4 description: Create and manage users in your workspace - name: Meeting Type V4 description: Configure meeting templates with durations, buffers, and conferencing - name: availability description: Manage weekly schedules and availability settings - name: Booking V4 description: Create new bookings - name: Booking Availability V4 description: Query available time slots for booking - name: Appointment V4 description: Manage existing appointments - name: Attendee V4 description: Manage attendee details and notes - name: Calendar Connections V4 description: Connect and sync external calendars - name: Signatures V4 description: >- Send PDFs for e-signature and download the signed, eIDAS-grade document (DocuSeal-compatible) - name: WhatsApp V4 description: >- Send and receive WhatsApp messages by phone number and read conversation history - name: One Time Booking Link V4 description: Create single-use booking links - name: availability-exception description: Override availability for specific dates - name: Booking Link V4 description: Configure various booking page types - name: Personal Page V4 description: Manage user profile pages - name: Handoff V4 description: Reassign meetings to other hosts - name: Calendar Auth V4 description: OAuth callbacks for calendar providers - name: CRM Contacts description: >- Create, find, and update the people in your CRM, including their custom data fields - name: CRM Deals description: >- Create, update, and track deals through pipeline stages (incl. per-deal activity history) - name: CRM Pipelines description: Manage pipelines and their stages - name: Data Fields description: >- Define the custom fields a contact can carry; their `name` is the key used in a contact's additionalData - name: Invoicing Documents description: >- Offers and invoices: create a draft, finalize it into a numbered e-invoice, send it, record payments, and run Mahnwesen - name: Invoicing Products description: Reusable products for invoice line items - name: Invoicing Settings description: Seller details, tax treatment, bank accounts, and number ranges - name: Invoicing Recurring description: >- Recurring schedules, billing runs over completed meetings, buyer prefill, and DATEV export - name: Queue V4 description: Round-robin and queue-based routing (Beta) - name: Queue User Group V4 description: Manage queue user groups (Beta) - name: Meeting Type Template V4 description: Reusable meeting type configurations (Beta) - name: Attendee Pending V4 description: Manage pending attendee approvals (Beta) - name: Provisional Booking V4 description: Manage provisional/unconfirmed bookings (Beta) paths: /data-field: post: tags: - Data Fields summary: Add a new data field operationId: addFormField parameters: - name: personal required: false in: query schema: type: boolean requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateDataFieldDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/DataField' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' security: - ApiKey: [] - JWT: [] - ApiUserHeader: [] components: schemas: CreateDataFieldDto: type: object properties: label: type: string fieldType: allOf: - $ref: '#/components/schemas/DataFieldType' target: allOf: - $ref: '#/components/schemas/DataFieldTarget' locales: type: array items: $ref: '#/components/schemas/FieldLocale' default: type: boolean required: type: boolean hidden: type: boolean hideUntilChange: type: boolean defaultValue: type: string placeholder: type: string options: type: array items: $ref: '#/components/schemas/FieldOptions' slideOptions: $ref: '#/components/schemas/SlideOptions' fileFieldOptions: description: |- Configuration for file upload fields. Required when fieldType is 'file'. allOf: - $ref: '#/components/schemas/FileFieldOptions' min: type: number description: Used by number field max: type: number description: Used by number field showInfobox: type: boolean infoboxText: type: string useMarkdown: type: boolean description: >- When true, field.label is rendered through markdown-it (html: false). Allows **bold**, _italic_, `code`, and links in field labels. default: false requireSignatureOtp: type: boolean default: false contactOptions: description: |- Configuration for contact composite fields. Controls which sub-inputs (name, email, phone, address) are shown. allOf: - $ref: '#/components/schemas/ContactOptions' helpText: type: string description: Optional help text shown below the field in the booking form. bankDetailsOptions: description: >- Configuration for bank details composite fields. Controls which optional sub-inputs (BIC, account holder, signature) are shown. allOf: - $ref: '#/components/schemas/BankDetailsOptions' licensePlateOptions: description: |- Configuration for license plate fields. Controls country format validation. allOf: - $ref: '#/components/schemas/LicensePlateOptions' displayStyle: type: object description: |- Controls how options are displayed for radio/checkbox/select fields. 'default' - Standard list view 'card' - Card grid with optional icons conditions: type: object nullable: true description: >- Conditional visibility expression. When set, the field is only shown when the expression evaluates to true against the current form values. headingLevel: type: number description: Heading level for heading fields (1–6). Defaults to 2 (

). pdfTemplateOptions: description: |- Configuration for PDF template fields. Holds the template PDF reference and pdfme schema JSON. allOf: - $ref: '#/components/schemas/PdfTemplateOptions' fileDownloadOptions: description: |- Configuration for file download display fields. Holds IDs of library files to offer for download. allOf: - $ref: '#/components/schemas/FileDownloadOptions' required: - label - fieldType - target - default - required - hidden DataField: type: object properties: id: type: number label: type: string name: type: string target: allOf: - $ref: '#/components/schemas/FormFieldTarget' fieldType: allOf: - $ref: '#/components/schemas/FormFieldType' order: type: number description: >- 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. locales: type: array items: $ref: '#/components/schemas/FieldLocale' default: type: boolean required: type: boolean hidden: type: boolean hideUntilChange: type: boolean mutable: type: boolean defaultValue: type: string placeholder: type: string options: type: array items: $ref: '#/components/schemas/FieldOptions' slideOptions: $ref: '#/components/schemas/SlideOptions' fileFieldOptions: description: |- Configuration for file upload fields. Only used when fieldType is 'file'. allOf: - $ref: '#/components/schemas/FileFieldOptions' contactOptions: description: >- Configuration for contact composite fields. Controls which sub-inputs (name, email, phone, address, etc.) are shown. allOf: - $ref: '#/components/schemas/ContactOptions' hubspotContactField: type: string hubspotCompanyField: type: string smartWeContactField: type: string smartWeCompanyField: type: string pipedriveContactField: type: string closeContactField: type: string salesforceContactField: type: string salesforceLeadField: type: string salesforceCaseField: type: string salesforceOpportunityField: type: string salesforceAccountField: type: string createdAt: format: date-time type: string updatedAt: format: date-time type: string deletedAt: type: string nullable: true helpText: type: string description: |- Optional help text shown below the field in the booking form. Provides additional guidance to users filling out the form. bankDetailsOptions: description: >- Configuration for bank details composite fields. Controls which optional sub-inputs (BIC, account holder, signature) are shown. allOf: - $ref: '#/components/schemas/BankDetailsOptions' licensePlateOptions: description: |- Configuration for license plate fields. Controls country format validation. allOf: - $ref: '#/components/schemas/LicensePlateOptions' pdfTemplateOptions: description: |- Configuration for PDF template fields. Holds the uploaded template PDF reference and pdfme schema JSON. allOf: - $ref: '#/components/schemas/PdfTemplateOptions' fileDownloadOptions: description: |- Configuration for file download display fields. Holds IDs of library files to offer for download. allOf: - $ref: '#/components/schemas/FileDownloadOptions' displayStyle: type: object description: |- Controls how options are displayed for radio/checkbox/select fields. 'default' - Standard list view 'card' - Card grid with optional icons conditions: type: object nullable: true description: >- 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. headingLevel: type: number description: |- Heading level for heading fields (1–6). Defaults to 2 (renders as

). signingPaused: type: boolean description: >- 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. showInfobox: type: boolean description: Only for data fields of type slide, enable to show an infobox. infoboxText: type: string description: Only for data fields of type slide, custom infobox text. companyId: type: string evalancheFieldId: type: string klicktippFieldId: type: string min: type: number description: |- Currently used by number field as min value. For string field, it is minimum amount of characters. max: type: number style: type: number description: |- For Phone Number field - used to set the style of phone input. 0 - Simple (Default) 1 - With country code picker defaultCountryCode: type: string description: >- 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. useMarkdown: type: boolean description: >- When true, field.label is rendered through markdown-it (html: false). Allows **bold**, _italic_, `code`, and links in field labels. requireSignatureOtp: type: boolean description: >- When true, the signer must verify their email via OTP before the signature canvas is unlocked. required: - id - label - name - target - fieldType - order - locales - default - required - hidden - hideUntilChange - mutable - options - createdAt - updatedAt - showInfobox - companyId - useMarkdown - requireSignatureOtp DataFieldType: 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 - file-download DataFieldTarget: type: string enum: - email - firstname - lastname - fullname - phone - other FieldLocale: type: object properties: locale: type: string label: type: string placeholder: type: string required: - locale - label FieldOptions: type: object properties: pointValue: type: number description: Points awarded when this option is selected (for scored forms) locales: description: >- Translations for the option label, same structure as field-level locales type: array items: $ref: '#/components/schemas/FieldLocale' label: type: string value: type: string image: type: string icon: type: string minValue: type: number description: Used by number fields, min value maxValue: type: number description: Used by number fields, max value required: - label - value SlideOptions: type: object properties: description: type: string multiselect: type: boolean type: allOf: - $ref: '#/components/schemas/SlideType' hideLabel: type: boolean childFields: type: array description: >- Per-page child-field instances inside the slide. The editor owns the SlideChildField shape (instanceId, index, dataFieldId, optional inline definition, legacy `required` flag, etc.). We accept it verbatim and keep the type loose because the legacy import path adds extra fields the editor doesn't model. Declaring it on the DTO is what lets a save carry childFields through: without it, class-transformer drops the unknown key from the request body, so DnD-added children never persist. items: type: object required: - description - multiselect - type FileFieldOptions: type: object properties: allowedExtensions: description: Allowed file extensions (e.g., pdf, docx, jpg) type: array items: type: string maxFileSizeMB: type: number description: Maximum file size in MB default: 5 maxFiles: type: number description: Maximum number of files default: 1 enableCameraCapture: type: boolean description: >- Enable camera capture on mobile devices (shows camera/file toggle). Only works when allowedExtensions includes image types. default: false required: - allowedExtensions - maxFileSizeMB - maxFiles ContactOptions: type: object properties: company: type: boolean description: >- Company name; becomes the invoice recipient when the field feeds billing default: false salutation: type: boolean default: false firstName: type: boolean default: true lastName: type: boolean default: true email: type: boolean default: true phone: type: boolean default: true mobile: type: boolean default: false birthdate: type: boolean default: false street: type: boolean default: false addressSupplement: type: boolean default: false zip: type: boolean default: false city: type: boolean default: false country: type: boolean default: false vatId: type: boolean description: USt-IdNr. / VAT ID, for B2B and reverse-charge invoicing default: false BankDetailsOptions: type: object properties: showBic: type: boolean default: true showAccountHolder: type: boolean default: true showSignature: type: boolean default: false LicensePlateOptions: type: object properties: countryFilter: type: string enum: - all - de default: all description: 'Country format filter: all = any country, de = German format only' PdfTemplateOptions: type: object properties: fileAssetId: type: string description: FileAsset ID of the uploaded PDF template pdfmeTemplate: type: object description: >- pdfme template schema JSON (positions of fields on the PDF). Does not include the basePdf bytes. requireSignature: type: boolean description: >- When true, respondent must draw a signature before accepting the document. default: false requireSignatureOtp: type: boolean description: >- When true, respondent must verify their identity via email OTP (FES) before signing. default: false required: - fileAssetId - pdfmeTemplate - requireSignature FileDownloadOptions: type: object properties: fileAssetIds: description: FileAsset IDs of library files to offer for download type: array items: type: string fileNames: type: object description: >- Map of fileAssetId → original filename for display without extra API calls additionalProperties: type: string required: - fileAssetIds FormFieldTarget: type: string enum: - email - firstname - lastname - fullname - phone - other FormFieldType: 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 - file-download ApiError: type: object required: - statusCode - message properties: statusCode: type: integer example: 400 message: oneOf: - type: string - type: array items: 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 error: type: string example: BadRequestException SlideType: type: string enum: - checkbox - page - image - icon responses: BadRequest: description: >- The request did not validate. `message` lists the constraints that failed. content: application/json: schema: $ref: '#/components/schemas/ApiError' Unauthorized: description: Missing, malformed, or expired credentials. content: application/json: schema: $ref: '#/components/schemas/ApiError' Forbidden: description: >- Authenticated, but not allowed: the plan does not include this feature, or the token is scoped away from it. content: application/json: schema: $ref: '#/components/schemas/ApiError' TooManyRequests: description: Rate limited. Back off and retry. content: application/json: schema: $ref: '#/components/schemas/ApiError' securitySchemes: ApiKey: scheme: bearer bearerFormat: API Key type: http description: >- Bearer token: a Platform API Key (format: ak_live::) or a Personal Access Token (format: rgo-...). PATs always act as the token owner. JWT: scheme: bearer bearerFormat: JWT type: http description: JWT Bearer token for standard user authentication 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. ````