Criar configuração de cliente

Cria a configuração de campos de cliente de uma empresa, incluindo o conjunto inicial de campos. Como cada empresa pode ter apenas uma configuração, este endpoint deve ser utilizado somente quando a empresa ainda não possui nenhuma — verifique previamente com a consulta por empresa. Caso já exista uma configuração, utilize a criação de campos ou de seções para adicioná-los à configuração existente.

Cada campo do array fields deve informar description e help como textos não vazios: a ausência de qualquer um deles retorna erro 400. O campo type deve pertencer ao conjunto fechado de 27 valores aceitos pela API; enviar um type fora desse conjunto (ou omitir o campo) retorna 400 com a lista completa de valores aceitos. Quando o tipo do campo for select ou checkList, as opções em options devem ser enviadas como uma lista simples de textos, nunca como objetos com rótulo e valor separados.

O index e o name de cada campo devem ser únicos dentro do array enviado nesta chamada — valores repetidos retornam erro.

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

{ "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" } ] }

Criar configuração de cliente

Requisição

Respostas