Excluir contato

Método

DELETE https://oapi.ogmma.com.br/v1/contacts/:id

Conceituação

Este endpoint realiza a exclusão de um contato com anonimização de dados em conformidade com a LGPD (Lei Geral de Proteção de Dados).

A exclusão é do tipo soft-delete: o registro do contato não é removido fisicamente do banco de dados, mas todos os dados pessoais são substituídos por informações genéricas anonimizadas. Isso permite que o histórico de mensagens e conversas seja mantido para fins de auditoria, sem expor dados pessoais.

Dados anonimizados:

• Nome substituído por "Contato Removido"
• Telefone substituído por hash irreversível
• E-mail removido
• Tags removidas
• Metadados removidos

Dados preservados:

• Histórico de mensagens (conteúdo das mensagens é mantido)
• Histórico de conversas (com referência ao contato anonimizado)
• Timestamps de criação e atualização

Atenção

Esta operação é irreversível. Após a anonimização, não é possível recuperar os dados originais do contato.

---

Atributos

Header

Atributo	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Bearer {API_KEY} - Chave de autenticação

Parâmetros de URL

Atributo	Tipo	Obrigatório	Descrição
id	string	Sim	ID do contato a ser excluído

---

Request

cURL

curl -X DELETE "https://oapi.ogmma.com.br/v1/contacts/{id}" \
  -H "Authorization: Bearer {API_KEY}"

Node.js

const axios = require('axios');

const response = await axios.delete(
  'https://oapi.ogmma.com.br/v1/contacts/{id}',
  {
    headers: {
      'Authorization': 'Bearer {API_KEY}'
    }
  }
);

console.log(response.data);

Python

import requests

response = requests.delete(
    'https://oapi.ogmma.com.br/v1/contacts/{id}',
    headers={
        'Authorization': 'Bearer {API_KEY}'
    }
)

print(response.json())

---

Response

200 - Success

O contato foi anonimizado com sucesso.

{
  "message": "Contato excluído e dados anonimizados com sucesso.",
  "id": "6650b2c3d4e5f6a7890124",
  "deletedAt": "2025-06-10T16:00:00Z"
}

400 - Bad Request

ID do contato inválido.

{
  "message": "O ID informado é inválido.",
  "code": "INVALID_OBJECT_ID"
}

401 - Unauthorized

Chave de API inválida ou ausente.

{
  "message": "Chave de API inválida ou expirada.",
  "code": "UNAUTHORIZED"
}

429 - Too Many Requests

Limite de requisições excedido.

{
  "message": "Limite de requisições excedido. Tente novamente em alguns segundos.",
  "code": "RATE_LIMIT_EXCEEDED"
}