Create fields

POST

/v1/client-config/{clientConfigId}/fields

Creates one or more fields in an existing client configuration, in a batch. Use this endpoint to add new fields to an already created configuration — for the initial creation of a configuration and its fields, use client configuration creation instead.

Each field requires name, type, index, description and help; omitting description or help as a non-empty string returns a 400 error naming the specific field. type must belong to the closed set of 27 values accepted by the API; an invalid or missing type returns 400 listing every accepted value. Fields of type select or checkList must send options as a plain list of strings.

The index and name of each field must be unique within the array sent in this call.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Campos criados

application/json

The fields were created successfully.

Bodyapplication/json

🟠400Payload inválido

🟠404Configuração não encontrada

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/client-config//fields' \
--header 'Content-Type: application/json' \
--data '{
    "fields": [
        {
            "name": "string",
            "type": "shortText",
            "index": 0,
            "required": true,
            "editable": true,
            "category": "default",
            "description": "string",
            "help": "string",
            "options": [
                "string"
            ],
            "variant": 0,
            "section": {
                "id": "string",
                "index": 0
            }
        }
    ]
}'

Response Example

201 - Exemplo 1

[
    {
        "id": "string",
        "name": "string",
        "type": "shortText",
        "index": 0,
        "required": true,
        "editable": true,
        "category": "default",
        "description": "string",
        "help": "string",
        "options": [
            "string"
        ],
        "variant": 0,
        "section": {
            "id": "string",
            "index": 0
        },
        "slug": "string",
        "uiComponent": "string"
    }
]

Modificado em 2026-07-28 20:38:32