Create client configuration

POST

/v1/client-config

Creates a company's client configuration, including the initial set of fields. Since each company can have only one configuration, this endpoint should be used only when the company does not yet have one — check beforehand with the get-by-company lookup. If a configuration already exists, use field or section creation to add to the existing configuration instead.

Each field in the fields array must provide description and help as non-empty strings: omitting either one returns a 400 error. The type field must belong to the closed set of 27 values accepted by the API; sending a type outside this set (or omitting it) returns a 400 error listing every accepted value. When the field type is select or checkList, the options in options must be sent as a plain list of strings, never as objects with separate label and value.

The index and name of each field must be unique within the array sent in this call — duplicate values return an error.

Requisição

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Configuração criada

application/json

The client configuration was created successfully.

Bodyapplication/json

🟠400Payload inválido

🟠409Empresa já possui configuração

Request Example

Shell

JavaScript

Java

Swift

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
            }
        }
    ]
}'

Response Example

201 - 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

Get client configuration by company

Próxima página

Update client configuration