Skip to content
Notavia Notavia Docs

Get a suppression by address

GET
/v1/suppressions/{address}
 
curl --request GET \
  --url https://your-notavia-host/v1/suppressions/example \
  --header 'Authorization: Bearer <token>'

Requires a full-access API key.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
address
required
string

The email address to look up. URL-encode special characters.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The suppression entry for the address.

Media type application/json
object
id
string format: uuid
address
string
reason
string
Allowed values: hard_bounce complaint manual_add
source
string
Allowed values: provider manual
diagnostic_detail
string
nullable
triggering_notification_id
string format: uuid
nullable
suppressed_at
string format: date-time
Example 
{
  "reason": "hard_bounce",
  "source": "provider"
}

401

Section titled “401 ”

Missing or invalid credentials.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}

403

Section titled “403 ”

Credentials do not have the required scope.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}

404

Section titled “404 ”

Resource not found.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}