Remove token do cliente
DELETE /api/{userId}/establishment/{establishmentId}/clients/{clientId}/tokens
Remove um token cadastrado para o cliente em um estabelecimento.
:::note Identificação do token no corpo
Diferentemente de outros endpoints de remoção (como o de cartões), neste endpoint o identificador do token (tokenId) é enviado no corpo da requisição, não na URL.
:::
Parâmetros de rota
| Nome | Tipo | Descrição |
|---|---|---|
userId | number | Identificador do usuário |
establishmentId | number | Identificador do estabelecimento |
clientId | string | Identificador do cliente |
Corpo (JSON)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
establishmentId | number | sim | Estabelecimento ao qual o token pertence. |
tokenId | number | sim | id do registro em jump_client_tokens (obtido via Lista tokens do cliente). |
Requisição
- Método:
DELETE - Path:
/api/\{userId\}/establishment/\{establishmentId\}/clients/\{clientId\}/tokens - Headers:
Authorization,Accept: application/json,Content-Type: application/json
Exemplo
curl -X DELETE "$JUMP_API_BASE_URL/api/{userId}/establishment/{establishmentId}/clients/{clientId}/tokens" \
-H "Authorization: Bearer <YOUR_API_TOKEN>" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"establishmentId": 7724,
"tokenId": 37
}'
Formato da resposta (JSON)
Segue o envelope padrão da API:
- Sucesso (HTTP 200):
{ "response": "success", "data": { "msg": "...", "code": "..." } } - Erro (HTTP 400):
{ "response": "error", "data": { "msg": "...", "code": "..." } }
Exemplo de resposta de sucesso
{
"response": "success",
"data": {
"msg": "Token removido com sucesso.",
"code": "Token removido com sucesso."
}
}
Exemplo de resposta de erro
{
"response": "error",
"data": {
"msg": "Não foi possível remover o token.",
"code": "Não foi possível remover o token."
}
}
Nuâncias
- A remoção só ocorre quando
establishmentId,clientIdetokenIdcoincidem com o registro emjump_client_tokens. Se qualquer um deles divergir, o endpoint retorna erro ("Não foi possível remover o token."). - A operação é registrada em
activity_historycomactivityTypeId = DELETEeactivitySourceId = CLIENT_TOKEN. - O registro também é marcado para sincronização via
SyncedItem.