API - Estolista

Estolistalla oleviin sähköpostiosoitteisiin ei lähetetä koskaan viestejä. API:n avulla voidaan lisätä, poistaa sekä lukea estolistaa.

Kenttien kuvaus

Eston lisääminen

Toiminnon avulla voidaan lisätä sähköpostiosoite estolistalle. API:n kautta lisätyt estot saavat aina reason-arvoksi deleted.

POST /v2/api/suppressions

cURL-esimerkki:

curl -i https://api.cmfile.net/v2/api/suppressions -H 'X-Access-Token:{ACCESS_TOKEN}' -H 'X-Request-Signature:{REQUEST_SIGNATURE}' -H 'X-Request-Timestamp: {TIMESTAMP}' -H "Content-Type: application/json" -d '{"email":"erkki@esimerkki.com"}' -X POST

Oletettu kutsu (JSON):

{
  "email": "erkki@esimerkki.com"
}

Oletettu vastaus (JSON):

HTTP/1.1 201 Created
Content-Type: application/json

{
  "message": "Suppression added.",
  "data": {
    "id": 789,
    "email": "erkki@esimerkki.com",
    "reason": "deleted",
    "created": "2026-05-15 09:00:00"
  }
}

Jos osoite on jo estolistalla, palautuu 409 Conflict:

HTTP/1.1 409 Conflict
Content-Type: application/json

{
  "message": "Email is already on suppression list."
}

Estolistan tiedot

Toiminnon avulla voidaan hakea estolistan sähköpostiosoitteet. Vastaus on sivutettu.

Valinnaiset parametrit

• pagesize: Montako riviä palautetaan per sivu, oletus 1000, maksimi 1000
• page: Sivu jolta tiedot palautetaan, oletus 1

GET /v2/api/suppressions?pagesize=1000&page=1

cURL-esimerkki:

curl -i 'https://api.cmfile.net/v2/api/suppressions?pagesize=1000&page=1' -H 'X-Access-Token:{ACCESS_TOKEN}' -H 'X-Request-Signature:{REQUEST_SIGNATURE}' -H 'X-Request-Timestamp: {TIMESTAMP}' -X GET

Oletettu vastaus (JSON):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": [
    {
      "id": 789,
      "email": "erkki@esimerkki.com",
      "reason": "deleted",
      "created": "2013-02-13 13:49:42"
    },
    ...
  ],
  "links": {
    "first": "https://api.cmfile.net/v2/api/suppressions?page=1",
    "last":  "https://api.cmfile.net/v2/api/suppressions?page=4",
    "prev":  null,
    "next":  "https://api.cmfile.net/v2/api/suppressions?page=2"
  },
  "meta": {
    "current_page": 1,
    "last_page":    4,
    "per_page":     1000,
    "total":        3127
  }
}

Eston poistaminen

Toiminnolla voidaan poistaa sähköpostiosoite estolistalta.

DELETE /v2/api/suppressions?email=erkki@esimerkki.com

cURL-esimerkki:

curl -i 'https://api.cmfile.net/v2/api/suppressions?email=erkki@esimerkki.com' -H 'X-Access-Token:{ACCESS_TOKEN}' -H 'X-Request-Signature:{REQUEST_SIGNATURE}' -H 'X-Request-Timestamp: {TIMESTAMP}' -X DELETE

Oletettu vastaus (JSON):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "message": "Suppression removed."
}