Update field

PUT

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

Updates an existing field by fully replacing its data, including name, type, index, description and help. Since this is a complete replacement, the required attributes from the original record must be resent; omitting description or help, for example, returns a 400 error.

When section is provided with a section identifier, the field becomes part of that section: the field's individual ordering index is then disregarded by the API (the server automatically sets it to null), and the field's position within the section follows the association order, not a configurable numeric value. To remove a field from its section, send section as null — the individual ordering index is then restored.

The category attribute (default for fixed registration fields or conditional for fields displayed only according to a rule) can be freely changed by this operation.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Campo atualizado

application/json

The field was updated successfully.

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

Get field

Próxima página

Partially update field