Suppress an address

POST

/suppressions

const url = 'https://mail.teamander.com/v1/suppressions';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"email_address":"bounced@example.com","reason":"manual"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://mail.teamander.com/v1/suppressions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email_address": "bounced@example.com", "reason": "manual" }'

Authorizations

bearerAuth

Request Body

application/json

object

email_address

required

string format: email

reason

string

default: manual

Allowed values: manual bounce complaint unsubscribe

Example

{
  "email_address": "bounced@example.com",
  "reason": "manual"
}

Responses

201

Suppressed

application/json

object

status

required

string

Allowed values: suppressed

Example

{
  "status": "suppressed"
}

400

Validation failed

application/json

object

error

required

string

details

object

key

additional properties

nullable

Example

{
  "error": "Validation failed",
  "details": {}
}

401

Missing or invalid API key

application/json

object

error

required

string

message

string

Example

{
  "error": "Invalid API key"
}