Pular para o conteúdo
Docs

Supressões criadas, atualizadas ou excluídas.

suppression.created

Enviado quando uma supressão é adicionada com Criar uma supressão, por uma importação de CSV no painel ou pela etapa Add to suppressions de uma automação. As supressões que o Emailit adiciona automaticamente após bounces e reclamações não enviam este evento; escute email.bounced e email.complained no lugar dele.

As requisições de webhook trazem um array JSON de eventos como este; consulte Requisições de webhook.

Campos

event_idstring

ID do evento (evt_…). Uma nova tentativa da requisição traz o mesmo ID, então use-o para ignorar eventos que você já processou. Você também pode consultar o evento com Obter um evento.

typestring

Sempre suppression.created.

objectobject

A supressão que o evento descreve. Os campos dela estão listados abaixo.

data.objectobject

O mesmo objeto de novo, no formato que a API de eventos retorna em data.

Objeto de supressão

idstring

ID da supressão (sup_…).

objectstring

Sempre suppression.

emailstring

Endereço suprimido, em minúsculas.

typestring

recipient, bounce, complaint ou unsubscribe. Apenas as supressões recipient bloqueiam envios pela API e por SMTP; as campanhas excluem endereços com qualquer tipo de supressão.

reasonstring | null

Motivo da supressão.

created_atstring

Quando a supressão foi criada, em ISO 8601 com deslocamento UTC.

keep_untilstring | null

Quando a supressão expira, ou null se ela for permanente.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "suppression.created",
  "object": {
    "id": "sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e",
    "object": "suppression",
    "email": "ada@example.com",
    "type": "recipient",
    "reason": "manual",
    "created_at": "2026-10-01T09:30:12.481000+00:00",
    "keep_until": null
  },
  "data": {
    "object": {
      "id": "sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e",
      "object": "suppression",
      "email": "ada@example.com",
      "type": "recipient",
      "reason": "manual",
      "created_at": "2026-10-01T09:30:12.481000+00:00",
      "keep_until": null
    }
  }
}

suppression.updated

Enviado quando uma supressão muda com Atualizar uma supressão.

As requisições de webhook trazem um array JSON de eventos como este; consulte Requisições de webhook.

Campos

event_idstring

ID do evento (evt_…). Uma nova tentativa da requisição traz o mesmo ID, então use-o para ignorar eventos que você já processou. Você também pode consultar o evento com Obter um evento.

typestring

Sempre suppression.updated.

objectobject

A supressão que o evento descreve. Os campos dela estão listados abaixo.

data.objectobject

O mesmo objeto de novo, no formato que a API de eventos retorna em data.

Objeto de supressão

idstring

ID da supressão (sup_…).

objectstring

Sempre suppression.

emailstring

Endereço suprimido, em minúsculas.

typestring

recipient, bounce, complaint ou unsubscribe. Apenas as supressões recipient bloqueiam envios pela API e por SMTP; as campanhas excluem endereços com qualquer tipo de supressão.

reasonstring | null

Motivo da supressão.

created_atstring

Quando a supressão foi criada, em ISO 8601 com deslocamento UTC.

keep_untilstring | null

Quando a supressão expira, ou null se ela for permanente.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "suppression.updated",
  "object": {
    "id": "sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e",
    "object": "suppression",
    "email": "ada@example.com",
    "type": "recipient",
    "reason": "Asked to pause invoices until January",
    "created_at": "2026-10-01T09:30:12.481000+00:00",
    "keep_until": "2027-01-01T00:00:00.000000+00:00"
  },
  "data": {
    "object": {
      "id": "sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e",
      "object": "suppression",
      "email": "ada@example.com",
      "type": "recipient",
      "reason": "Asked to pause invoices until January",
      "created_at": "2026-10-01T09:30:12.481000+00:00",
      "keep_until": "2027-01-01T00:00:00.000000+00:00"
    }
  }
}

suppression.deleted

Enviado quando uma supressão é excluída com Excluir uma supressão. Uma supressão expirada continua na lista e não envia este evento, assim como a etapa Remove from suppressions de uma automação.

As requisições de webhook trazem um array JSON de eventos como este; consulte Requisições de webhook.

Campos

event_idstring

ID do evento (evt_…). Uma nova tentativa da requisição traz o mesmo ID, então use-o para ignorar eventos que você já processou. Você também pode consultar o evento com Obter um evento.

typestring

Sempre suppression.deleted.

objectobject

A supressão que o evento descreve. Os campos dela estão listados abaixo.

data.objectobject

O mesmo objeto de novo, no formato que a API de eventos retorna em data.

Objeto de supressão

idstring

ID da supressão (sup_…).

objectstring

Sempre suppression.

emailstring

Endereço suprimido, em minúsculas.

typestring

recipient, bounce, complaint ou unsubscribe. Apenas as supressões recipient bloqueiam envios pela API e por SMTP; as campanhas excluem endereços com qualquer tipo de supressão.

reasonstring | null

Motivo da supressão.

created_atstring

Quando a supressão foi criada, em ISO 8601 com deslocamento UTC.

keep_untilstring | null

Quando a supressão expira, ou null se ela for permanente.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "suppression.deleted",
  "object": {
    "id": "sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e",
    "object": "suppression",
    "email": "ada@example.com",
    "type": "recipient",
    "reason": "manual",
    "created_at": "2026-10-01T09:30:12.481000+00:00",
    "keep_until": null
  },
  "data": {
    "object": {
      "id": "sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e",
      "object": "suppression",
      "email": "ada@example.com",
      "type": "recipient",
      "reason": "manual",
      "created_at": "2026-10-01T09:30:12.481000+00:00",
      "keep_until": null
    }
  }
}

Esta página foi útil?

Obrigado pelo feedback.

Obrigado, lemos todas as mensagens.