Suppressions

Import suppressed email addresses

POST/v1/suppressions/import

Requires an API key with the suppressions:write scope. About keys and scopes

Admin, or a key with suppressions:write; never an agent key. Blocks up to 10,000 addresses per request with reason imported, for example opt-outs carried over from another platform. Addresses are trimmed and lowercased; one already blocked keeps its reason. Nothing is sent to anyone.

Request body

addressesstring[]required

Email addresses to block, up to 10,000; trimmed and lowercased.

at least 1 item · at most 10000 items

Returns

Returns 200 OK. Otherwise returns an error; Errors lists every code and which to retry.

addedCountintegerrequired

Newly blocked addresses.

min 0 · max 9007199254740991

alreadySuppressedCountintegerrequired

Already blocked, for any reason; their reason is left as it was.

min 0 · max 9007199254740991

invalidstring[]required

Entries that are not an email address, exactly as sent.

curl -X POST https://api.kirora.io/v1/suppressions/import \
  -H "Authorization: Bearer $KIRORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "addresses": [
      "addresses_example"
    ]
  }'

const response = await fetch('https://api.kirora.io/v1/suppressions/import', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "addresses": [
      "addresses_example"
    ]
  }),
});
const { data } = await response.json();

import os

import requests

response = requests.post(
    "https://api.kirora.io/v1/suppressions/import",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
    json={
        "addresses": [
            "addresses_example",
        ],
    },
)
data = response.json()["data"]

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
	"os"
)

func main() {
	body := []byte(`{
	  "addresses": [
	    "addresses_example"
	  ]
	}`)
	req, err := http.NewRequest("POST", "https://api.kirora.io/v1/suppressions/import", bytes.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var out struct {
		Data json.RawMessage `json:"data"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
}

Response · 200

{
  "data": {
    "addedCount": 0,
    "alreadySuppressedCount": 0,
    "invalid": [
      "invalid_example"
    ]
  }
}

Example values are generated from the schema.