Add a new data field

POST

data-field

curl --request POST \
  --url https://api.example.com/data-field \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "default": true,
  "required": true,
  "hidden": true,
  "locales": [
    {
      "locale": "<string>",
      "label": "<string>",
      "placeholder": "<string>"
    }
  ],
  "hideUntilChange": true,
  "defaultValue": "<string>",
  "placeholder": "<string>",
  "options": [
    {
      "label": "<string>",
      "value": "<string>",
      "pointValue": 123,
      "locales": [
        {
          "locale": "<string>",
          "label": "<string>",
          "placeholder": "<string>"
        }
      ],
      "image": "<string>",
      "icon": "<string>",
      "minValue": 123,
      "maxValue": 123
    }
  ],
  "min": 123,
  "max": 123,
  "showInfobox": true,
  "infoboxText": "<string>",
  "useMarkdown": false,
  "requireSignatureOtp": 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
  },
  "helpText": "<string>",
  "bankDetailsOptions": {
    "showBic": true,
    "showAccountHolder": true,
    "showSignature": false
  },
  "licensePlateOptions": {
    "countryFilter": "all"
  },
  "displayStyle": {},
  "conditions": {},
  "headingLevel": 123
}
'

import requests

url = "https://api.example.com/data-field"

payload = {
    "label": "<string>",
    "default": True,
    "required": True,
    "hidden": True,
    "locales": [
        {
            "locale": "<string>",
            "label": "<string>",
            "placeholder": "<string>"
        }
    ],
    "hideUntilChange": True,
    "defaultValue": "<string>",
    "placeholder": "<string>",
    "options": [
        {
            "label": "<string>",
            "value": "<string>",
            "pointValue": 123,
            "locales": [
                {
                    "locale": "<string>",
                    "label": "<string>",
                    "placeholder": "<string>"
                }
            ],
            "image": "<string>",
            "icon": "<string>",
            "minValue": 123,
            "maxValue": 123
        }
    ],
    "min": 123,
    "max": 123,
    "showInfobox": True,
    "infoboxText": "<string>",
    "useMarkdown": False,
    "requireSignatureOtp": 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
    },
    "helpText": "<string>",
    "bankDetailsOptions": {
        "showBic": True,
        "showAccountHolder": True,
        "showSignature": False
    },
    "licensePlateOptions": { "countryFilter": "all" },
    "displayStyle": {},
    "conditions": {},
    "headingLevel": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    label: '<string>',
    default: true,
    required: true,
    hidden: true,
    locales: [{locale: '<string>', label: '<string>', placeholder: '<string>'}],
    hideUntilChange: true,
    defaultValue: '<string>',
    placeholder: '<string>',
    options: [
      {
        label: '<string>',
        value: '<string>',
        pointValue: 123,
        locales: [{locale: '<string>', label: '<string>', placeholder: '<string>'}],
        image: '<string>',
        icon: '<string>',
        minValue: 123,
        maxValue: 123
      }
    ],
    min: 123,
    max: 123,
    showInfobox: true,
    infoboxText: '<string>',
    useMarkdown: false,
    requireSignatureOtp: 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
    },
    helpText: '<string>',
    bankDetailsOptions: {showBic: true, showAccountHolder: true, showSignature: false},
    licensePlateOptions: {countryFilter: 'all'},
    displayStyle: {},
    conditions: {},
    headingLevel: 123
  })
};

fetch('https://api.example.com/data-field', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/data-field",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'label' => '<string>',
    'default' => true,
    'required' => true,
    'hidden' => true,
    'locales' => [
        [
                'locale' => '<string>',
                'label' => '<string>',
                'placeholder' => '<string>'
        ]
    ],
    'hideUntilChange' => true,
    'defaultValue' => '<string>',
    'placeholder' => '<string>',
    'options' => [
        [
                'label' => '<string>',
                'value' => '<string>',
                'pointValue' => 123,
                'locales' => [
                                [
                                                                'locale' => '<string>',
                                                                'label' => '<string>',
                                                                'placeholder' => '<string>'
                                ]
                ],
                'image' => '<string>',
                'icon' => '<string>',
                'minValue' => 123,
                'maxValue' => 123
        ]
    ],
    'min' => 123,
    'max' => 123,
    'showInfobox' => true,
    'infoboxText' => '<string>',
    'useMarkdown' => false,
    'requireSignatureOtp' => 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
    ],
    'helpText' => '<string>',
    'bankDetailsOptions' => [
        'showBic' => true,
        'showAccountHolder' => true,
        'showSignature' => false
    ],
    'licensePlateOptions' => [
        'countryFilter' => 'all'
    ],
    'displayStyle' => [
        
    ],
    'conditions' => [
        
    ],
    'headingLevel' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/data-field"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"default\": true,\n  \"required\": true,\n  \"hidden\": true,\n  \"locales\": [\n    {\n      \"locale\": \"<string>\",\n      \"label\": \"<string>\",\n      \"placeholder\": \"<string>\"\n    }\n  ],\n  \"hideUntilChange\": true,\n  \"defaultValue\": \"<string>\",\n  \"placeholder\": \"<string>\",\n  \"options\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"pointValue\": 123,\n      \"locales\": [\n        {\n          \"locale\": \"<string>\",\n          \"label\": \"<string>\",\n          \"placeholder\": \"<string>\"\n        }\n      ],\n      \"image\": \"<string>\",\n      \"icon\": \"<string>\",\n      \"minValue\": 123,\n      \"maxValue\": 123\n    }\n  ],\n  \"min\": 123,\n  \"max\": 123,\n  \"showInfobox\": true,\n  \"infoboxText\": \"<string>\",\n  \"useMarkdown\": false,\n  \"requireSignatureOtp\": false,\n  \"contactOptions\": {\n    \"company\": false,\n    \"salutation\": false,\n    \"firstName\": true,\n    \"lastName\": true,\n    \"email\": true,\n    \"phone\": true,\n    \"mobile\": false,\n    \"birthdate\": false,\n    \"street\": false,\n    \"addressSupplement\": false,\n    \"zip\": false,\n    \"city\": false,\n    \"country\": false,\n    \"vatId\": false\n  },\n  \"helpText\": \"<string>\",\n  \"bankDetailsOptions\": {\n    \"showBic\": true,\n    \"showAccountHolder\": true,\n    \"showSignature\": false\n  },\n  \"licensePlateOptions\": {\n    \"countryFilter\": \"all\"\n  },\n  \"displayStyle\": {},\n  \"conditions\": {},\n  \"headingLevel\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/data-field")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"default\": true,\n  \"required\": true,\n  \"hidden\": true,\n  \"locales\": [\n    {\n      \"locale\": \"<string>\",\n      \"label\": \"<string>\",\n      \"placeholder\": \"<string>\"\n    }\n  ],\n  \"hideUntilChange\": true,\n  \"defaultValue\": \"<string>\",\n  \"placeholder\": \"<string>\",\n  \"options\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"pointValue\": 123,\n      \"locales\": [\n        {\n          \"locale\": \"<string>\",\n          \"label\": \"<string>\",\n          \"placeholder\": \"<string>\"\n        }\n      ],\n      \"image\": \"<string>\",\n      \"icon\": \"<string>\",\n      \"minValue\": 123,\n      \"maxValue\": 123\n    }\n  ],\n  \"min\": 123,\n  \"max\": 123,\n  \"showInfobox\": true,\n  \"infoboxText\": \"<string>\",\n  \"useMarkdown\": false,\n  \"requireSignatureOtp\": false,\n  \"contactOptions\": {\n    \"company\": false,\n    \"salutation\": false,\n    \"firstName\": true,\n    \"lastName\": true,\n    \"email\": true,\n    \"phone\": true,\n    \"mobile\": false,\n    \"birthdate\": false,\n    \"street\": false,\n    \"addressSupplement\": false,\n    \"zip\": false,\n    \"city\": false,\n    \"country\": false,\n    \"vatId\": false\n  },\n  \"helpText\": \"<string>\",\n  \"bankDetailsOptions\": {\n    \"showBic\": true,\n    \"showAccountHolder\": true,\n    \"showSignature\": false\n  },\n  \"licensePlateOptions\": {\n    \"countryFilter\": \"all\"\n  },\n  \"displayStyle\": {},\n  \"conditions\": {},\n  \"headingLevel\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/data-field")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"default\": true,\n  \"required\": true,\n  \"hidden\": true,\n  \"locales\": [\n    {\n      \"locale\": \"<string>\",\n      \"label\": \"<string>\",\n      \"placeholder\": \"<string>\"\n    }\n  ],\n  \"hideUntilChange\": true,\n  \"defaultValue\": \"<string>\",\n  \"placeholder\": \"<string>\",\n  \"options\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"pointValue\": 123,\n      \"locales\": [\n        {\n          \"locale\": \"<string>\",\n          \"label\": \"<string>\",\n          \"placeholder\": \"<string>\"\n        }\n      ],\n      \"image\": \"<string>\",\n      \"icon\": \"<string>\",\n      \"minValue\": 123,\n      \"maxValue\": 123\n    }\n  ],\n  \"min\": 123,\n  \"max\": 123,\n  \"showInfobox\": true,\n  \"infoboxText\": \"<string>\",\n  \"useMarkdown\": false,\n  \"requireSignatureOtp\": false,\n  \"contactOptions\": {\n    \"company\": false,\n    \"salutation\": false,\n    \"firstName\": true,\n    \"lastName\": true,\n    \"email\": true,\n    \"phone\": true,\n    \"mobile\": false,\n    \"birthdate\": false,\n    \"street\": false,\n    \"addressSupplement\": false,\n    \"zip\": false,\n    \"city\": false,\n    \"country\": false,\n    \"vatId\": false\n  },\n  \"helpText\": \"<string>\",\n  \"bankDetailsOptions\": {\n    \"showBic\": true,\n    \"showAccountHolder\": true,\n    \"showSignature\": false\n  },\n  \"licensePlateOptions\": {\n    \"countryFilter\": \"all\"\n  },\n  \"displayStyle\": {},\n  \"conditions\": {},\n  \"headingLevel\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "label": "<string>",
  "name": "<string>",
  "order": 123,
  "locales": [
    {
      "locale": "<string>",
      "label": "<string>",
      "placeholder": "<string>"
    }
  ],
  "default": true,
  "required": true,
  "hidden": true,
  "hideUntilChange": true,
  "mutable": true,
  "options": [
    {
      "label": "<string>",
      "value": "<string>",
      "pointValue": 123,
      "locales": [
        {
          "locale": "<string>",
          "label": "<string>",
          "placeholder": "<string>"
        }
      ],
      "image": "<string>",
      "icon": "<string>",
      "minValue": 123,
      "maxValue": 123
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "showInfobox": true,
  "companyId": "<string>",
  "useMarkdown": true,
  "requireSignatureOtp": true,
  "defaultValue": "<string>",
  "placeholder": "<string>",
  "slideOptions": {
    "description": "<string>",
    "multiselect": true,
    "hideLabel": true,
    "childFields": [
      {}
    ]
  },
  "fileFieldOptions": {
    "allowedExtensions": [
      "<string>"
    ],
    "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": "<string>",
  "hubspotCompanyField": "<string>",
  "smartWeContactField": "<string>",
  "smartWeCompanyField": "<string>",
  "pipedriveContactField": "<string>",
  "closeContactField": "<string>",
  "salesforceContactField": "<string>",
  "salesforceLeadField": "<string>",
  "salesforceCaseField": "<string>",
  "salesforceOpportunityField": "<string>",
  "salesforceAccountField": "<string>",
  "deletedAt": "<string>",
  "helpText": "<string>",
  "bankDetailsOptions": {
    "showBic": true,
    "showAccountHolder": true,
    "showSignature": false
  },
  "licensePlateOptions": {
    "countryFilter": "all"
  },
  "pdfTemplateOptions": {
    "fileAssetId": "<string>",
    "pdfmeTemplate": {},
    "requireSignature": false,
    "requireSignatureOtp": false
  },
  "fileDownloadOptions": {
    "fileAssetIds": [
      "<string>"
    ],
    "fileNames": {}
  },
  "displayStyle": {},
  "conditions": {},
  "headingLevel": 123,
  "signingPaused": true,
  "infoboxText": "<string>",
  "evalancheFieldId": "<string>",
  "klicktippFieldId": "<string>",
  "min": 123,
  "max": 123,
  "style": 123,
  "defaultCountryCode": "<string>"
}

{
  "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"
}

Authorizations

Authorization

string

header

required

Bearer token: a Platform API Key (format: ak_live::) or a Personal Access Token (format: rgo-...). PATs always act as the token owner.

Query Parameters

personal

boolean

Body

application/json

label

string

required

fieldType

enum<string>

required

Available options:

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

target

enum<string>

required

Available options:

email,

firstname,

lastname,

fullname,

phone,

other

default

boolean

required

boolean

required

hidden

boolean

required

locales

object[]

Show child attributes

hideUntilChange

boolean

defaultValue

string

placeholder

string

options

object[]

Show child attributes

slideOptions

object

Show child attributes

fileFieldOptions

object

Configuration for file upload fields. Required when fieldType is 'file'.

Show child attributes

min

number

Used by number field

max

number

Used by number field

showInfobox

boolean

infoboxText

string

useMarkdown

boolean

default:false

When true, field.label is rendered through markdown-it (html: false). Allows bold, italic, code, and links in field labels.

requireSignatureOtp

boolean

default:false

contactOptions

object

Configuration for contact composite fields. Controls which sub-inputs (name, email, phone, address) are shown.

Show child attributes

helpText

string

Optional help text shown below the field in the booking form.

bankDetailsOptions

object

Configuration for bank details composite fields. Controls which optional sub-inputs (BIC, account holder, signature) are shown.

Show child attributes

licensePlateOptions

object

Configuration for license plate fields. Controls country format validation.

Show child attributes

displayStyle

object

Controls how options are displayed for radio/checkbox/select fields. 'default' - Standard list view 'card' - Card grid with optional icons

conditions

object | null

Conditional visibility expression. When set, the field is only shown when the expression evaluates to true against the current form values.

headingLevel

number

Heading level for heading fields (1–6). Defaults to 2 (

).

pdfTemplateOptions

object

Configuration for PDF template fields. Holds the template PDF reference and pdfme schema JSON.

Show child attributes

fileDownloadOptions

object

Configuration for file download display fields. Holds IDs of library files to offer for download.

Show child attributes

Response

number

required

label

string

required

name

string

required

target

enum<string>

required

Available options:

email,

firstname,

lastname,

fullname,

phone,

other

fieldType

enum<string>

required

Available options:

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

order

number

required

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

object[]

required

Show child attributes

default

boolean

required

boolean

required

hidden

boolean

required

hideUntilChange

boolean

required

mutable

boolean

required

options

object[]

required

Show child attributes

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

showInfobox

boolean

required

Only for data fields of type slide, enable to show an infobox.

companyId

string

required

useMarkdown

boolean

required

When true, field.label is rendered through markdown-it (html: false). Allows bold, italic, code, and links in field labels.

requireSignatureOtp

boolean

required

When true, the signer must verify their email via OTP before the signature canvas is unlocked.

defaultValue

string

placeholder

string

slideOptions

object

Show child attributes

fileFieldOptions

object

Configuration for file upload fields. Only used when fieldType is 'file'.

Show child attributes

contactOptions

object

Configuration for contact composite fields. Controls which sub-inputs (name, email, phone, address, etc.) are shown.

Show child attributes

hubspotContactField

string

hubspotCompanyField

string

smartWeContactField

string

smartWeCompanyField

string

pipedriveContactField

string

closeContactField

string

salesforceContactField

string

salesforceLeadField

string

salesforceCaseField

string

salesforceOpportunityField

string

salesforceAccountField

string

deletedAt

string | null

helpText

string

Optional help text shown below the field in the booking form. Provides additional guidance to users filling out the form.

bankDetailsOptions

object

Configuration for bank details composite fields. Controls which optional sub-inputs (BIC, account holder, signature) are shown.

Show child attributes

licensePlateOptions

object

Configuration for license plate fields. Controls country format validation.

Show child attributes

pdfTemplateOptions

object

Configuration for PDF template fields. Holds the uploaded template PDF reference and pdfme schema JSON.

Show child attributes

fileDownloadOptions

object

Configuration for file download display fields. Holds IDs of library files to offer for download.

Show child attributes

displayStyle

object

Controls how options are displayed for radio/checkbox/select fields. 'default' - Standard list view 'card' - Card grid with optional icons

conditions

object | null

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

number

Heading level for heading fields (1–6). Defaults to 2 (renders as

).

signingPaused

boolean

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.

infoboxText

string

Only for data fields of type slide, custom infobox text.

evalancheFieldId

string

klicktippFieldId

string

min

number

Currently used by number field as min value. For string field, it is minimum amount of characters.

max

number

style

number

For Phone Number field - used to set the style of phone input. 0 - Simple (Default) 1 - With country code picker

defaultCountryCode

string

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.

Add a new data field

curl --request POST \
  --url https://api.example.com/data-field \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "default": true,
  "required": true,
  "hidden": true,
  "locales": [
    {
      "locale": "<string>",
      "label": "<string>",
      "placeholder": "<string>"
    }
  ],
  "hideUntilChange": true,
  "defaultValue": "<string>",
  "placeholder": "<string>",
  "options": [
    {
      "label": "<string>",
      "value": "<string>",
      "pointValue": 123,
      "locales": [
        {
          "locale": "<string>",
          "label": "<string>",
          "placeholder": "<string>"
        }
      ],
      "image": "<string>",
      "icon": "<string>",
      "minValue": 123,
      "maxValue": 123
    }
  ],
  "min": 123,
  "max": 123,
  "showInfobox": true,
  "infoboxText": "<string>",
  "useMarkdown": false,
  "requireSignatureOtp": 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
  },
  "helpText": "<string>",
  "bankDetailsOptions": {
    "showBic": true,
    "showAccountHolder": true,
    "showSignature": false
  },
  "licensePlateOptions": {
    "countryFilter": "all"
  },
  "displayStyle": {},
  "conditions": {},
  "headingLevel": 123
}
'

import requests

url = "https://api.example.com/data-field"

payload = {
    "label": "<string>",
    "default": True,
    "required": True,
    "hidden": True,
    "locales": [
        {
            "locale": "<string>",
            "label": "<string>",
            "placeholder": "<string>"
        }
    ],
    "hideUntilChange": True,
    "defaultValue": "<string>",
    "placeholder": "<string>",
    "options": [
        {
            "label": "<string>",
            "value": "<string>",
            "pointValue": 123,
            "locales": [
                {
                    "locale": "<string>",
                    "label": "<string>",
                    "placeholder": "<string>"
                }
            ],
            "image": "<string>",
            "icon": "<string>",
            "minValue": 123,
            "maxValue": 123
        }
    ],
    "min": 123,
    "max": 123,
    "showInfobox": True,
    "infoboxText": "<string>",
    "useMarkdown": False,
    "requireSignatureOtp": 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
    },
    "helpText": "<string>",
    "bankDetailsOptions": {
        "showBic": True,
        "showAccountHolder": True,
        "showSignature": False
    },
    "licensePlateOptions": { "countryFilter": "all" },
    "displayStyle": {},
    "conditions": {},
    "headingLevel": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    label: '<string>',
    default: true,
    required: true,
    hidden: true,
    locales: [{locale: '<string>', label: '<string>', placeholder: '<string>'}],
    hideUntilChange: true,
    defaultValue: '<string>',
    placeholder: '<string>',
    options: [
      {
        label: '<string>',
        value: '<string>',
        pointValue: 123,
        locales: [{locale: '<string>', label: '<string>', placeholder: '<string>'}],
        image: '<string>',
        icon: '<string>',
        minValue: 123,
        maxValue: 123
      }
    ],
    min: 123,
    max: 123,
    showInfobox: true,
    infoboxText: '<string>',
    useMarkdown: false,
    requireSignatureOtp: 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
    },
    helpText: '<string>',
    bankDetailsOptions: {showBic: true, showAccountHolder: true, showSignature: false},
    licensePlateOptions: {countryFilter: 'all'},
    displayStyle: {},
    conditions: {},
    headingLevel: 123
  })
};

fetch('https://api.example.com/data-field', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/data-field",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'label' => '<string>',
    'default' => true,
    'required' => true,
    'hidden' => true,
    'locales' => [
        [
                'locale' => '<string>',
                'label' => '<string>',
                'placeholder' => '<string>'
        ]
    ],
    'hideUntilChange' => true,
    'defaultValue' => '<string>',
    'placeholder' => '<string>',
    'options' => [
        [
                'label' => '<string>',
                'value' => '<string>',
                'pointValue' => 123,
                'locales' => [
                                [
                                                                'locale' => '<string>',
                                                                'label' => '<string>',
                                                                'placeholder' => '<string>'
                                ]
                ],
                'image' => '<string>',
                'icon' => '<string>',
                'minValue' => 123,
                'maxValue' => 123
        ]
    ],
    'min' => 123,
    'max' => 123,
    'showInfobox' => true,
    'infoboxText' => '<string>',
    'useMarkdown' => false,
    'requireSignatureOtp' => 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
    ],
    'helpText' => '<string>',
    'bankDetailsOptions' => [
        'showBic' => true,
        'showAccountHolder' => true,
        'showSignature' => false
    ],
    'licensePlateOptions' => [
        'countryFilter' => 'all'
    ],
    'displayStyle' => [
        
    ],
    'conditions' => [
        
    ],
    'headingLevel' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/data-field"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"default\": true,\n  \"required\": true,\n  \"hidden\": true,\n  \"locales\": [\n    {\n      \"locale\": \"<string>\",\n      \"label\": \"<string>\",\n      \"placeholder\": \"<string>\"\n    }\n  ],\n  \"hideUntilChange\": true,\n  \"defaultValue\": \"<string>\",\n  \"placeholder\": \"<string>\",\n  \"options\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"pointValue\": 123,\n      \"locales\": [\n        {\n          \"locale\": \"<string>\",\n          \"label\": \"<string>\",\n          \"placeholder\": \"<string>\"\n        }\n      ],\n      \"image\": \"<string>\",\n      \"icon\": \"<string>\",\n      \"minValue\": 123,\n      \"maxValue\": 123\n    }\n  ],\n  \"min\": 123,\n  \"max\": 123,\n  \"showInfobox\": true,\n  \"infoboxText\": \"<string>\",\n  \"useMarkdown\": false,\n  \"requireSignatureOtp\": false,\n  \"contactOptions\": {\n    \"company\": false,\n    \"salutation\": false,\n    \"firstName\": true,\n    \"lastName\": true,\n    \"email\": true,\n    \"phone\": true,\n    \"mobile\": false,\n    \"birthdate\": false,\n    \"street\": false,\n    \"addressSupplement\": false,\n    \"zip\": false,\n    \"city\": false,\n    \"country\": false,\n    \"vatId\": false\n  },\n  \"helpText\": \"<string>\",\n  \"bankDetailsOptions\": {\n    \"showBic\": true,\n    \"showAccountHolder\": true,\n    \"showSignature\": false\n  },\n  \"licensePlateOptions\": {\n    \"countryFilter\": \"all\"\n  },\n  \"displayStyle\": {},\n  \"conditions\": {},\n  \"headingLevel\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/data-field")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"default\": true,\n  \"required\": true,\n  \"hidden\": true,\n  \"locales\": [\n    {\n      \"locale\": \"<string>\",\n      \"label\": \"<string>\",\n      \"placeholder\": \"<string>\"\n    }\n  ],\n  \"hideUntilChange\": true,\n  \"defaultValue\": \"<string>\",\n  \"placeholder\": \"<string>\",\n  \"options\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"pointValue\": 123,\n      \"locales\": [\n        {\n          \"locale\": \"<string>\",\n          \"label\": \"<string>\",\n          \"placeholder\": \"<string>\"\n        }\n      ],\n      \"image\": \"<string>\",\n      \"icon\": \"<string>\",\n      \"minValue\": 123,\n      \"maxValue\": 123\n    }\n  ],\n  \"min\": 123,\n  \"max\": 123,\n  \"showInfobox\": true,\n  \"infoboxText\": \"<string>\",\n  \"useMarkdown\": false,\n  \"requireSignatureOtp\": false,\n  \"contactOptions\": {\n    \"company\": false,\n    \"salutation\": false,\n    \"firstName\": true,\n    \"lastName\": true,\n    \"email\": true,\n    \"phone\": true,\n    \"mobile\": false,\n    \"birthdate\": false,\n    \"street\": false,\n    \"addressSupplement\": false,\n    \"zip\": false,\n    \"city\": false,\n    \"country\": false,\n    \"vatId\": false\n  },\n  \"helpText\": \"<string>\",\n  \"bankDetailsOptions\": {\n    \"showBic\": true,\n    \"showAccountHolder\": true,\n    \"showSignature\": false\n  },\n  \"licensePlateOptions\": {\n    \"countryFilter\": \"all\"\n  },\n  \"displayStyle\": {},\n  \"conditions\": {},\n  \"headingLevel\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/data-field")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"default\": true,\n  \"required\": true,\n  \"hidden\": true,\n  \"locales\": [\n    {\n      \"locale\": \"<string>\",\n      \"label\": \"<string>\",\n      \"placeholder\": \"<string>\"\n    }\n  ],\n  \"hideUntilChange\": true,\n  \"defaultValue\": \"<string>\",\n  \"placeholder\": \"<string>\",\n  \"options\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"pointValue\": 123,\n      \"locales\": [\n        {\n          \"locale\": \"<string>\",\n          \"label\": \"<string>\",\n          \"placeholder\": \"<string>\"\n        }\n      ],\n      \"image\": \"<string>\",\n      \"icon\": \"<string>\",\n      \"minValue\": 123,\n      \"maxValue\": 123\n    }\n  ],\n  \"min\": 123,\n  \"max\": 123,\n  \"showInfobox\": true,\n  \"infoboxText\": \"<string>\",\n  \"useMarkdown\": false,\n  \"requireSignatureOtp\": false,\n  \"contactOptions\": {\n    \"company\": false,\n    \"salutation\": false,\n    \"firstName\": true,\n    \"lastName\": true,\n    \"email\": true,\n    \"phone\": true,\n    \"mobile\": false,\n    \"birthdate\": false,\n    \"street\": false,\n    \"addressSupplement\": false,\n    \"zip\": false,\n    \"city\": false,\n    \"country\": false,\n    \"vatId\": false\n  },\n  \"helpText\": \"<string>\",\n  \"bankDetailsOptions\": {\n    \"showBic\": true,\n    \"showAccountHolder\": true,\n    \"showSignature\": false\n  },\n  \"licensePlateOptions\": {\n    \"countryFilter\": \"all\"\n  },\n  \"displayStyle\": {},\n  \"conditions\": {},\n  \"headingLevel\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "label": "<string>",
  "name": "<string>",
  "order": 123,
  "locales": [
    {
      "locale": "<string>",
      "label": "<string>",
      "placeholder": "<string>"
    }
  ],
  "default": true,
  "required": true,
  "hidden": true,
  "hideUntilChange": true,
  "mutable": true,
  "options": [
    {
      "label": "<string>",
      "value": "<string>",
      "pointValue": 123,
      "locales": [
        {
          "locale": "<string>",
          "label": "<string>",
          "placeholder": "<string>"
        }
      ],
      "image": "<string>",
      "icon": "<string>",
      "minValue": 123,
      "maxValue": 123
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "showInfobox": true,
  "companyId": "<string>",
  "useMarkdown": true,
  "requireSignatureOtp": true,
  "defaultValue": "<string>",
  "placeholder": "<string>",
  "slideOptions": {
    "description": "<string>",
    "multiselect": true,
    "hideLabel": true,
    "childFields": [
      {}
    ]
  },
  "fileFieldOptions": {
    "allowedExtensions": [
      "<string>"
    ],
    "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": "<string>",
  "hubspotCompanyField": "<string>",
  "smartWeContactField": "<string>",
  "smartWeCompanyField": "<string>",
  "pipedriveContactField": "<string>",
  "closeContactField": "<string>",
  "salesforceContactField": "<string>",
  "salesforceLeadField": "<string>",
  "salesforceCaseField": "<string>",
  "salesforceOpportunityField": "<string>",
  "salesforceAccountField": "<string>",
  "deletedAt": "<string>",
  "helpText": "<string>",
  "bankDetailsOptions": {
    "showBic": true,
    "showAccountHolder": true,
    "showSignature": false
  },
  "licensePlateOptions": {
    "countryFilter": "all"
  },
  "pdfTemplateOptions": {
    "fileAssetId": "<string>",
    "pdfmeTemplate": {},
    "requireSignature": false,
    "requireSignatureOtp": false
  },
  "fileDownloadOptions": {
    "fileAssetIds": [
      "<string>"
    ],
    "fileNames": {}
  },
  "displayStyle": {},
  "conditions": {},
  "headingLevel": 123,
  "signingPaused": true,
  "infoboxText": "<string>",
  "evalancheFieldId": "<string>",
  "klicktippFieldId": "<string>",
  "min": 123,
  "max": 123,
  "style": 123,
  "defaultCountryCode": "<string>"
}

{
  "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"
}

CRM Contacts

CRM Pipelines

CRM Deals

availability

availability-exception

WhatsApp V4

Signatures V4

Data Fields

Invoicing Products

Invoicing Settings

Invoicing Recurring

Invoicing Documents

Meeting Type V4

Booking Availability V4

Queue V4

Queue User Group V4

Meeting Type Template V4

One Time Booking Link V4

Provisional Booking V4

Handoff V4

Booking Link V4

Booking V4

appointment

Attendee V4

Appointment V4

Attendee Pending V4

Personal Page V4

User V4

Calendar Auth V4

Calendar Connections V4

Add a new data field

Authorizations

Query Parameters

Body

).

Response

).