Email Suppressions

List suppressions

Changed on

Account-scoped list. Two mutually exclusive pagination modes:

  • Offset: page[number] (default 1) + page[size] (default 25, max 100). meta contains total_pages.
  • Cursor: page[after] and/or page[before] (opaque Base.url_encode64 of {"created_at","id"}). Cannot combine with page[number]; after+before together is an error. meta contains next_cursor / previous_cursor (omitted when their flag is false).

Sort defaults to -created_at (desc); only created_at is sortable. A -- prefix is an error. nil/empty filter values are silently dropped.

get/email_blocks

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/email_blocks
  • Auth: HTTP bearer

Query parameters

page[number]integer

Offset page number (≥1, default 1).

page[size]integer

Page size (1–100, default 25).

page[after]string

Opaque cursor (Base.url_encode64 of {"created_at","id"}). Cursor mode; mutually exclusive with page[number] and page[before].

page[before]string

Opaque cursor (see page[after]). Mutually exclusive with page[after] and page[number].

sort'created_at' | '-created_at'

Sort field. Leading - = desc; only created_at is sortable. Default -created_at. -- is an error.

filter[reason]'hard_bounce' | 'spam_complaint' | 'unsubscribe' | 'invalid' | 'manual_block'

Exact-match filter on reason.

filter[domain_id]string uuid

Exact-match filter on domain_id (UUID).

filter[created_after]string date-time

created_at > value (ISO 8601).

filter[created_before]string date-time

created_at < value (ISO 8601).

Response

List of suppressions.

OR

Changes