Atualizar configuração de cliente

PUT

/v1/client-config/{clientConfigId}

Substitui integralmente a lista de campos de uma configuração de cliente existente. O array fields enviado passa a ser a única fonte de verdade da configuração: qualquer campo existente que não conste no array é efetivamente descartado.

Cada campo do array segue as mesmas regras de validação da criação, incluindo description e help obrigatórios e não vazios, type pertencente ao conjunto de valores aceitos, options como lista simples de textos quando aplicável, e index/name únicos dentro do array.

Para atualizações pontuais que preservem os campos não mencionados, utilize a atualização parcial de um campo individual.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Configuração atualizada

application/json

A configuração de cliente foi atualizada com sucesso.

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

Criar configuração de cliente

Próxima página

Obter configuração de cliente