Update client configuration

PUT

/v1/client-config/{clientConfigId}

Fully replaces the list of fields of an existing client configuration. The fields array sent becomes the configuration's single source of truth: any existing field not included in the array is effectively discarded.

Each field in the array follows the same validation rules as creation, including required non-empty description and help, type belonging to the accepted set of values, options as a plain list of strings where applicable, and unique index/name within the array.

For targeted updates that preserve fields not mentioned, use the partial update of an individual field instead.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Configuração atualizada

application/json

The client configuration was updated successfully.

Bodyapplication/json

🟠400Payload inválido

🟠404Configuração não encontrada

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Exemplo 1

{
    "id": "string",
    "companyId": "string",
    "fields": [
        {
            "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

Create client configuration

Próxima página

Get client configuration