Atualizar campo

PUT

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

Atualiza um campo existente substituindo integralmente os seus dados, incluindo name, type, index, description e help. Por se tratar de uma substituição completa, os atributos obrigatórios do cadastro original devem ser reenviados; a omissão de description ou help, por exemplo, retorna erro 400.

Ao informar section com o identificador de uma seção, o campo passa a integrar essa seção: o índice de ordenação individual do campo é então desconsiderado pela API (o servidor o define automaticamente como nulo), e a posição do campo dentro da seção passa a seguir a ordem de associação, não um valor numérico configurável. Para desassociar um campo de sua seção, envie section como nulo — o índice de ordenação individual é então restabelecido.

O atributo category (default para campos fixos do cadastro ou conditional para campos exibidos apenas conforme uma regra) pode ser alterado livremente por esta operação.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Campo atualizado

application/json

O campo foi atualizado com sucesso.

Bodyapplication/json

🟠400Payload inválido

🟠404Campo não encontrado

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/v1/client-config//fields/' \
--header 'Content-Type: application/json' \
--data '{
    "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

200 - 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

Página anterior

Obter campo

Próxima página

Atualizar campo parcialmente