Criar campos

POST

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

Cria um ou mais campos em uma configuração de cliente existente, em lote. Utilize este endpoint para adicionar novos campos a uma configuração já criada — para a criação inicial de uma configuração e seus campos, utilize a criação de configuração de cliente.

Cada campo requer name, type, index, description e help; a ausência de description ou help como texto não vazio retorna erro 400 informando o campo específico. O type deve pertencer ao conjunto fechado de 27 valores aceitos pela API; um type inválido ou ausente retorna 400 com a lista completa de valores aceitos. Campos do tipo select ou checkList devem enviar options como lista simples de textos.

O index e o name de cada campo devem ser únicos dentro do array enviado nesta chamada.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Campos criados

application/json

Os campos foram criados com sucesso.

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