Suppression

Endpointhttps://api.lettermint.co/v1

List all suppressions for the team

GET

https://api.lettermint.co/v1

/suppressions

List all suppressions for the team › query Parameters

sort

string

Available sorts are value, created_at, reason. You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -value.

Default: -created_at

page[size]

integer

The number of results that will be returned per page.

Default: 30

page[cursor]

string

The cursor to start the pagination from.

filter[scope]

string

Filter by scope (team, project, route)

filter[route_id]

string

Filter by route ID

filter[project_id]

string

Filter by project ID

filter[value]

string

Search by email/domain value (partial match)

filter[reason]

string · enum

Enum values:

spam_complaint

hard_bounce

unsubscribe

manual

List all suppressions for the team › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

List all suppressions for the team › Responses

200

Paginated set of SuppressedRecipientData

object[] · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · required

Number of items shown per page.

next_cursor

string | null · required

The "cursor" that points to the next set of items.

next_page_url

string | null · uri · required

prev_cursor

string | null · required

The "cursor" that points to the previous set of items.

prev_page_url

string | null · uri · required

Add email(s) to suppression list

POST

https://api.lettermint.co/v1

/suppressions

Add email(s) to suppression list › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Add email(s) to suppression list › Request Body

reason

string · enum · required

Enum values:

spam_complaint

hard_bounce

unsubscribe

manual

scope

string · enum · required

Enum values:

team

project

route

email

string | null · email · maxLength: 255

route_id

string | null · uuid

project_id

string | null · uuid

emails

array | null · minItems: 1 · maxItems: 1000

Add email(s) to suppression list › Responses

required

object · required

POST/suppressions

curl --request POST \
  --url https://api.lettermint.co/v1/suppressions \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "test@example.com",
  "reason": "spam_complaint",
  "scope": "team",
  "route_id": "00000000-0000-0000-0000-000000000000",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "emails": [
    "test@example.com"
  ]
}
'

shell

Example Request Body

{
  "email": "test@example.com",
  "reason": "spam_complaint",
  "scope": "team",
  "route_id": "00000000-0000-0000-0000-000000000000",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "emails": [
    "test@example.com"
  ]
}

json

Example Responses

{
  "message": "string",
  "data": {
    "created": [
      "string"
    ],
    "skipped": [
      "string"
    ]
  }
}

json

application/json

Remove email from suppression list

DELETE

https://api.lettermint.co/v1

/suppressions/{suppressionId}

Remove email from suppression list › path Parameters

suppressionId

string · required

Remove email from suppression list › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Remove email from suppression list › Responses

message

string · const · required

Const value: Email removed from suppression list successfully.

Message Stats

List all suppressions for the team

GET

https://api.lettermint.co/v1

/suppressions

List all suppressions for the team › query Parameters

sort

string

Default: -created_at

page[size]

integer

The number of results that will be returned per page.

Default: 30

page[cursor]

string

The cursor to start the pagination from.

filter[scope]

string

Filter by scope (team, project, route)

filter[route_id]

string

Filter by route ID

filter[project_id]

string

Filter by project ID

filter[value]

string

Search by email/domain value (partial match)

filter[reason]

string · enum

Enum values:

spam_complaint

hard_bounce

unsubscribe

manual

List all suppressions for the team › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

List all suppressions for the team › Responses

200

Paginated set of SuppressedRecipientData

object[] · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · required

Number of items shown per page.

next_cursor

string | null · required

The "cursor" that points to the next set of items.

next_page_url

string | null · uri · required

prev_cursor

string | null · required

The "cursor" that points to the previous set of items.

prev_page_url

string | null · uri · required

Add email(s) to suppression list

POST

https://api.lettermint.co/v1

/suppressions

Add email(s) to suppression list › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Add email(s) to suppression list › Request Body

reason

string · enum · required

Enum values:

spam_complaint

hard_bounce

unsubscribe

manual

scope

string · enum · required

Enum values:

team

project

route

email

string | null · email · maxLength: 255

route_id

string | null · uuid

project_id

string | null · uuid

emails

array | null · minItems: 1 · maxItems: 1000

Add email(s) to suppression list › Responses

required

object · required

Remove email from suppression list

DELETE

https://api.lettermint.co/v1

/suppressions/{suppressionId}

Remove email from suppression list › path Parameters

suppressionId

string · required

Remove email from suppression list › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Remove email from suppression list › Responses

message

string · const · required

Const value: Email removed from suppression list successfully.