messaging_suppressions

Manually add an email address to the suppression list

Manually suppress an email address so no workflow sends to it.

post/api/projects/{project_id}/messaging_suppressions/add_suppression/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/messaging_suppressions/add_suppression/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

identifierstring required

The email address to suppress. Will not receive any messages until removed.

Response

idstring uuid required

Server-assigned UUID for this suppression entry.

identifierstring required

Normalized recipient email address. Suppression is keyed on this value, per team.

source'BOUNCE' | 'MANUAL' | 'COMPLAINT' required
  • BOUNCE - Bounce
  • MANUAL - Manual
  • COMPLAINT - Complaint
reasonstring nullable required

Human-readable reason for the suppression (e.g. 'Auto-suppressed after 5 consecutive soft bounces').

transient_bounce_countinteger required

Rolling count of consecutive soft bounces with no successful delivery in between. Reset to 0 on any successful delivery. Ignored for MANUAL entries.

last_bounce_atstring date-time nullable required

Timestamp of the most recent bounce, if any.

last_bounce_diagnosticstring nullable required

SMTP diagnostic string from the most recent bounce (e.g. '550 5.1.1 user unknown'), kept for visibility.

suppressedboolean required

Whether the address is actively suppressed. A BOUNCE row can exist while still only counting bounces (suppressed=false) before it crosses the threshold.

suppressed_atstring date-time nullable required

Timestamp when the address was first suppressed.

created_atstring date-time required

When the row was first created (first bounce or manual add).

updated_atstring date-time required

When the row was last touched by any write.

Changes

No recorded changes to this operation across all 1 revision of this API.