Skip to content

List suppressed addresses

GET
/api/v1/email-sending/suppressions
curl --request GET \
--url https://digize.com/api/v1/email-sending/suppressions \
--header 'x-api-key: <x-api-key>'

Addresses the workspace’s email won’t go to, for every sending domain or one, the newest first.

Needs the sites:read permission.

Done

Media typeapplication/json
Array<object>
object
id
required
string
address
required
string
reason
required
string
Allowed values: hard_bounce soft_bounce complaint manual policy
domain
required
string | null
detail
required
string
addedAt
required
string format: date-time
expiresAt
required
Any of:
string format: date-time
readOnly
required
boolean

Example

[
{
"reason": "hard_bounce"
}
]

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}