List suppressions

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

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const response of client.emailBlocks.list()) {
  console.log(response);
}

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
page = client.email_blocks.list()
print(page)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	emailBlocks, err := client.EmailBlocks.List(context.TODO())
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", emailBlocks.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        var page = client.emailBlocks().list();
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

page = telnyx.email_blocks.list

puts(page)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->emailBlocks->list();

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx email-blocks list \
  --api-key 'My API Key'

curl --request GET \
  --url https://api.telnyx.com/v2/email_blocks \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "record_type": "email_block",
      "to": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "from": "<string>",
      "expires_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page_number": 123,
    "page_size": 123,
    "total_pages": 123,
    "total_results": 123
  }
}

{
  "errors": [
    {
      "code": "10015",
      "title": "Validation Failed",
      "detail": "is invalid",
      "source": {
        "pointer": "/filter[reason]"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unauthorized",
      "detail": "Missing authentication"
    }
  ]
}

{
  "errors": [
    {
      "code": "406",
      "title": "Not Acceptable",
      "detail": "Not Acceptable"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page[number]

integer

default:1

Offset page number (≥1, default 1).

Required range: x >= 1

page[size]

integer

default:25

Page size (1–100, default 25).

Required range: 1 <= x <= 100

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

enum<string>

default:-created_at

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

Available options:

created_at,

-created_at

filter[reason]

enum<string>

Exact-match filter on reason.

Available options:

hard_bounce,

spam_complaint,

unsubscribe,

invalid,

manual_block

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.

Option 1
Option 2

data

object[]

required

Show child attributes

meta

object

required

Show child attributes

Suppressions & Unsubscribes

Create a manual suppression

⌘I

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const response of client.emailBlocks.list()) {
  console.log(response);
}

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
page = client.email_blocks.list()
print(page)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	emailBlocks, err := client.EmailBlocks.List(context.TODO())
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", emailBlocks.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        var page = client.emailBlocks().list();
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

page = telnyx.email_blocks.list

puts(page)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->emailBlocks->list();

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx email-blocks list \
  --api-key 'My API Key'

curl --request GET \
  --url https://api.telnyx.com/v2/email_blocks \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "record_type": "email_block",
      "to": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "from": "<string>",
      "expires_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page_number": 123,
    "page_size": 123,
    "total_pages": 123,
    "total_results": 123
  }
}

{
  "errors": [
    {
      "code": "10015",
      "title": "Validation Failed",
      "detail": "is invalid",
      "source": {
        "pointer": "/filter[reason]"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unauthorized",
      "detail": "Missing authentication"
    }
  ]
}

{
  "errors": [
    {
      "code": "406",
      "title": "Not Acceptable",
      "detail": "Not Acceptable"
    }
  ]
}

Getting Started

Domains & DNS

Sending Email

Receiving Email

Email Validations

Templates

Events & Webhooks

Suppressions

Deliverability

List suppressions

Authorizations

Query Parameters

Response