Remover cliente

PATCH

/clients/{clientId}/delete

Remove o cliente informado em clientId: ele passa a constar como removido e, se pertencia a um grupo, é retirado dele. A remoção é lógica, os dados do cliente não são apagados. Remover de novo um cliente já removido também devolve 200. Cliente inexistente devolve 400 (Cliente não existe!), com a mensagem dentro de um objeto no campo message. Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200

application/json

Cliente removido

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Cliente ou grupo inexistente

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/clients/7c9e6679-7425-40de-944b-e07fc1f90ae7/delete' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Exemplo 1

{}

Modificado em 2026-10-13 09:47:06

Página anterior

Consultar quantide de clientes por classificação

Próxima página

Cadastrar grupos