Encerrar conversa

Método

PATCH https://oapi.ogmma.com.br/v1/conversations/:id/close

Conceituação

Este endpoint encerra uma conversa ativa, alterando seu status para CLOSED. Uma conversa encerrada indica que o atendimento foi finalizado.

Se o contato enviar uma nova mensagem após o encerramento, uma nova conversa será criada automaticamente.

Nenhum corpo é necessário na requisição.

---

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 da conversa a ser encerrada

---

Request Body

Nenhum. Este endpoint não requer corpo na requisição.

---

Response

200 - Success

A conversa foi encerrada com sucesso.

{
  "data": {
    "id": "6650f4c2e8b1a2d3f4567890",
    "channelId": "6650a1b2c3d4e5f6a7890123",
    "contact": {
      "id": "6650b2c3d4e5f6a7890124",
      "name": "Maria Silva",
      "phone": "5511999990001"
    },
    "assignedTo": {
      "id": "6650c3d4e5f6a7890125",
      "name": "João Atendente"
    },
    "status": "CLOSED",
    "closedAt": "2025-06-10T15:00:00Z",
    "updatedAt": "2025-06-10T15:00:00Z"
  }
}

400 - Bad Request

A conversa já está encerrada.

{
  "message": "A conversa já está encerrada.",
  "code": "CONVERSATION_ALREADY_CLOSED"
}

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"
}