Cadastrar

POST

/customer

Cadastra um cliente junto com o seu usuário principal (root), que poderá acessar a plataforma e gerar tokens de Cliente.

Disponível para: Somente Revendedor
Rate limit: 100 requisições/minuto

Regras

O cliente é sempre criado ativo.

O e-mail (userEmail) é o login do usuário principal.

Sem timeZoneId, é usado o fuso padrão (ID 13).

Idiomas e demais IDs de referência: https://app.apidog.com/project/922569/apis/doc-1335233

A resposta traz o cliente completo, igual ao item de GET /customer.

Erros específicos

languageId inexistente → 400 com {"error": "language_id inválido: <id>"}.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Bodyapplication/jsonObrigatório

Examples

Respostas

🟢200Sucesso

application/json

Bodyapplication/json

🟠400Bad request

🟠403Forbidden

🔴500Internal server error

🟠429Too Many Request

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.cloud-services.yuv.com.br/customer' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerName": "Transportadora Exemplo",
    "userName": "Maria Souza",
    "userEmail": "maria@exemplo.com.br",
    "userPassword": "senha123",
    "permissionGroupId": 1,
    "languageId": 1,
    "timeZoneId": 13,
    "customerZipCode": "01310-100",
    "customerAddress": "Av. Paulista, 1000",
    "customerCity": "São Paulo",
    "customerPhone": "(11) 99999-0000",
    "streamingLimit": 5
}'

Response Example

200 - Sucesso

{
    "data": {
        "customerId": 1,
        "customerName": "Customer123",
        "customerEmail": "email123@example.com",
        "customerIsEnabled": true,
        "permissionGroup": null,
        "occurrenceSetting": null,
        "customerCnpj": "00000000000000",
        "customerZipCode": "00000-000",
        "customerAddress": "Address123",
        "customerComplement": "Complement123",
        "customerNeighborhood": "Neighborhood123",
        "customerCity": "City123",
        "customerState": "ST",
        "customerPhone": "00000000000",
        "customerObservation": "Observation123",
        "customerStreamingLimit": 10,
        "occurrenceSettingId": 1,
        "alarmSettingId": 1,
        "alarmSetting": null,
        "customerCreatedAt": "2026-01-01T00:00:00Z",
        "customerUpdatedAt": "2026-01-01T00:00:00Z",
        "userId": 1,
        "userName": "User123",
        "userIsEnabled": true,
        "userTypeId": 4,
        "permissionGroupId": 1,
        "languageId": 1,
        "language": null,
        "timeZoneId": 13,
        "timeZone": null
    }
}

Modificado em 2026-10-02 19:54:21

Cadastrar

Regras#

Erros específicos#

Requisição

Respostas

Regras

Erros específicos