Atualizar campo parcialmente

PATCH

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

Atualiza parcialmente um campo existente. Diferentemente da substituição completa, aceita apenas os atributos que devem ser alterados — os demais permanecem com o valor atual.

O mesmo comportamento de seção descrito na atualização completa se aplica aqui: ao informar section com um identificador, o índice individual do campo é automaticamente definido como nulo pela API, e a ordem do campo dentro da seção passa a seguir a ordem de associação. Enviar section como nulo remove o campo da seção e restabelece seu índice individual.

O atributo category também pode ser alterado por esta operação, permitindo alternar um campo entre o comportamento fixo (default) e o condicional (conditional).

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

🟠404Campo não encontrado

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/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