Edita um cliente

PUT /api/{userId}/establishment/{establishmentId}/clients/{clientId}

Parâmetros de rota

Nome	Tipo	Descrição
userId	number	Identificador do usuário
establishmentId	number	Identificador do estabelecimento
clientId	string	Identificador do cliente

Requisição

• Método: PUT
• Path: /api/\{userId\}/establishment/\{establishmentId\}/clients/\{clientId\}
• Headers: Authorization, Accept: application/json, Content-Type: application/json
• Autorização: envie o token no header Authorization: Bearer <YOUR_API_TOKEN>.

Corpo (JSON)

Campos obrigatórios

Campo	Tipo	Descrição
establishmentId	number	Identificador do estabelecimento
id	string	Identificador do cliente — deve ser o mesmo valor de clientId na URL

Campos opcionais — dados do cliente (jump_clients)

Campo	Tipo	Descrição
name	string	Nome
documentId	string	CPF/CNPJ (normalizado; tipo inferido pelo tamanho)
email	string	E-mail
dateOfBirth	string	Data (YYYY-MM-DD); vazio vira 0001-01-01
postalCode	string	CEP
street	string	Logradouro
streetNumber	string / number	Número; vazio vira 0
streetComplement	string	Complemento
district	string	Bairro
city	string	Cidade
state	string	UF
phones	array / string	Telefones (array serializado em JSON; vazio limpa)
comments	string	Observações
status	number	Controla a ativação/desativação do cliente. 1 = ativado, 0 = desativado. Quando omitido ou null, assume 1. Veja detalhes abaixo.

:::warning Ativação e desativação do cliente Não existe um endpoint dedicado a ativar/desativar um cliente. Isso é feito exclusivamente pelo campo status no próprio payload de atualização (PUT /clients/{clientId}):

Valor	Significado	Efeito
1	Ativado	Cliente operante; aparece nos fluxos normais.
0	Desativado	Cliente inativo; removido dos fluxos operacionais.

Efeitos automáticos ao alterar o status

• status = 0 (desativar): cliente é marcado como inativo, a atividade é registrada como INACTIVATE no histórico, sincronizado com remove = 1 e, se houver fatura em aberto vinculada, ela também é desativada (status = 0).
• status = 1 (ativar, partindo de cliente desativado): cliente é reativado, registrado como ACTIVATE no histórico, e faturas pendentes vinculadas voltam ao estado ativo (status = 1).
• Quando status não é enviado no payload, nenhum log de ativação/desativação é gerado — a requisição é tratada como edição comum de cadastro.

Exemplos

Desativar um cliente (status = 0):

{
  "establishmentId": 7724,
  "id": "772420260215093421",
  "status": 0
}

Ativar um cliente (status = 1):

{
  "establishmentId": 7724,
  "id": "772420260215093421",
  "status": 1
}

:::

Endpoints relacionados

Este endpoint cuida apenas dos dados cadastrais do cliente. Demais configurações possuem endpoints dedicados:

Configuração	Endpoint
Cartões de acesso	POST /clients/{clientId}/cards/new e DELETE /clients/{clientId}/cards/{cardCode}
Vínculo de tabelas de preço (typePricesLink)	PUT /clients/{clientId}/type-prices-link
Vínculo de serviços (servicesLink)	PUT /clients/{clientId}/services-link
Restrições de acesso (startTime, endTime, weekDaysPermission, vacancies, period, restrictionTypePrice)	PUT /clients/{clientId}/restrictions
Cobrança/recorrência (amount, invoiceDueDay, frequencyId, penalty, closingDays, etc.)	PUT /clients/{clientId}/charge
Automações de cobrança	PUT /clients/{clientId}/charge-automations
Veículos	POST /clients/{clientId}/vehicles/new e DELETE /clients/{clientId}/vehicles/{plate}

Formato da resposta (JSON)

• Sucesso (HTTP 200): { "response": "success", "data": <payload> }
• Erro (HTTP 400): { "response": "error", "data": { "msg": "...", "code": "..." } }
• Não autorizado / permissão: Autorização

Exemplo de resposta (JSON)

Valores ilustrativos; a forma dos campos segue o retorno real.

{
  "response": "success",
  "data": {
    "clientId": "772420260215093421",
    "name": "Marcelo Vieira",
    "email": "[email protected]",
    "documentId": "",
    "documentIdType": 1,
    "dateOfBirth": "1992-07-14",
    "postalCode": "01310-100",
    "street": "Av. Paulista",
    "streetNumber": "1200",
    "streetComplement": "Sala 402",
    "district": "Bela Vista",
    "city": "São Paulo",
    "state": "SP",
    "phones": ["+5511988877665"],
    "vehicles": [
      {
        "plate": "RXY4E88",
        "vehicleColor": "Prata",
        "vehicleModel": "Hatch"
      }
    ],
    "mainClientId": null,
    "establishmentId": 7724,
    "clientTypeId": 1,
    "restrictionTypePrice": null,
    "amount": null,
    "closingDays": null,
    "toleranceDays": null,
    "invoiceDueDay": null,
    "contractDueDate": "0001-01-01",
    "frequencyId": 1,
    "penalty": "0.00",
    "penaltyType": 1,
    "period": null,
    "startTime": "00:00:00",
    "endTime": "00:00:00",
    "weekDaysPermission": [1, 2, 3, 4, 5, 6, 7],
    "vacancies": 0,
    "cards": [],
    "typePricesLink": [],
    "servicesLink": [],
    "comments": "Cliente preferencial — estacionamento bloco B",
    "status": 1,
    "typePrices": [],
    "services": []
  }
}