Partially update field

PATCH

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

Partially updates an existing field. Unlike the full replacement, it accepts only the attributes that should change — the rest keep their current value.

The same section behavior described for the full update applies here: when section is provided with an identifier, the field's individual index is automatically set to null by the API, and the field's order within the section follows the association order. Sending section as null removes the field from the section and restores its individual index.

The category attribute can also be changed by this operation, allowing a field to switch between fixed (default) and conditional (conditional) behavior.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Campo atualizado

application/json

The field was updated successfully.

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