latestOpenAPI 3.0.32026-08-215925112.0 MB

36be0dca14e7

api
data-fields

Create a Data Field

post/api/data-fields

Request body

titlestring nullable

The default title of the data field

descriptionstring nullable

The default description of the data field

isPersonalDataboolean

Whether the data field is personal data

type'text' | 'number' | 'select' | 'checkbox' | 'tel' | 'country' | 'email' | 'date' | 'documentUpload' | 'signature' | 'address' required

The type of data field

optionsstring[]

An array of options when type is select

minLengthnumber float nullable

Minimum length for a text input

maxLengthnumber float nullable

Maximum length for a text input

namestring required

Response

Created

_idstring required

The ID of the data field

sellerIdstring required

The ID of the seller of the data field

namestring required

The name of the data field

titlestring nullable

The default title of the data field

isPersonalDataboolean

Whether the data field is personal data

descriptionstring nullable

The default description of the data field

type'text' | 'number' | 'select' | 'checkbox' | 'tel' | 'country' | 'email' | 'date' | 'documentUpload' | 'signature' | 'address' required

The type of data field

slugstring required

The slug generated out of name

optionsstring[]

An array of options when type is select

minLengthnumber float nullable

Minimum length for a text input

maxLengthnumber float nullable

Maximum length for a text input