Documentação da API
POST /disable_contact
Resumo
Este endpoint permite desativar um contato existente em uma unidade específica.
Descrição
Utilize este endpoint para desativar logicamente um contato, alterando seu status para inativo. O contato deve existir e estar associado à unidade informada.
Requisição
Body da Requisição
O corpo deve ser um objeto JSON com os seguintes parâmetros:
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
access_token | string | Sim | Token de autenticação do usuário. | aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee |
unit_token | string | Sim | Token identificador da unidade. | aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee |
token | string | Sim | Token identificador do contato a ser desativado. | aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee |
Exemplo de Requisição
Curl
curl -X POST 'https://portal.fipli.pro/api/v1/disable_contact' \
-H 'Content-Type: application/json' \
-d '{
"access_token": "<access_token>",
"unit_token": "<unit_token>",
"token": "<token>"
}'
Resposta
200 OK
Desativação realizada com sucesso.
{
"success": true,
"message": "Contact disabled successfully."
}
Erros Comuns
| Status | Mensagem | Descrição |
|---|---|---|
400 | "Missing parameters" | Algum parâmetro obrigatório (access_token, unit_token, token) não foi enviado. |
403 | "Invalid data" | Token de autenticação inválido ou não autorizado. |
500 | "Something went wrong. Please try again later." | Erro interno no servidor. |
Observações
- A desativação é lógica, ou seja, o contato não é removido do banco de dados, apenas marcado como inativo (
active: false). - Certifique-se de que os tokens estejam válidos e que o contato exista no sistema.
- A operação é realizada de forma transacional, garantindo a consistência dos dados no banco.