Cancelar envio em massa

Método

POST https://oapi.ogmma.com.br/v1/bulk/:batchId/cancel

Conceituação

Este endpoint permite cancelar um lote de envio em massa que esteja com status QUEUED ou IN_PROGRESS. As mensagens que já foram enviadas não são afetadas pelo cancelamento -- apenas as mensagens pendentes deixam de ser processadas.

Após o cancelamento, o status do lote é atualizado para CANCELLED e os contadores refletem a quantidade de mensagens que foram efetivamente enviadas antes do cancelamento.

---

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
batchId	string	Sim	ID do lote a ser cancelado

---

Request

cURL

curl -X POST "https://oapi.ogmma.com.br/v1/bulk/{batchId}/cancel" \
  -H "Authorization: Bearer {API_KEY}"

Node.js

const axios = require('axios');

const batchId = 'bulk_6651a3b2c4d5e6f7a8901234';

const response = await axios.post(
  `https://oapi.ogmma.com.br/v1/bulk/${batchId}/cancel`,
  {},
  {
    headers: {
      'Authorization': 'Bearer {API_KEY}'
    }
  }
);

console.log(response.data);

Python

import requests

batch_id = 'bulk_6651a3b2c4d5e6f7a8901234'

response = requests.post(
    f'https://oapi.ogmma.com.br/v1/bulk/{batch_id}/cancel',
    headers={
        'Authorization': 'Bearer {API_KEY}'
    }
)

print(response.json())

---

Response

200 - Success

O lote foi cancelado com sucesso. Retorna o lote atualizado.

{
  "data": {
    "batchId": "bulk_6651a3b2c4d5e6f7a8901234",
    "status": "CANCELLED",
    "cancelledAt": "2025-06-10T15:12:45Z"
  }
}

400 - Bad Request

O lote não pode ser cancelado (já concluído ou já cancelado).

{
  "message": "O lote já foi concluído e não pode ser cancelado.",
  "code": "BULK_BATCH_NOT_CANCELLABLE"
}

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