Tämän osion artikkelit

API - Estolista

Avatar
Creamailer Support
  • Päivitetty
Seuraa

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

Kenttien kuvaus

Nimi Tyyppi Kijoitusoikeus Pakollinen Tiedot
email string kyllä kyllä Sähköpostiosoite. 2-100 merkkiä.
reason string ei ei Eston syy. Vaihtoehdot: unsubscribed = perunut uutiskirjeen, bounced = lisätty virheelinen takia, spamreport = lisätty roskapostimerkkauksen takia, deleted = lisätty ylläpitäjän toimesta.
created datetime ei ei Eston lisäyspäivämäärä (YYYY-MM-DD HH:MM:SS).

Eston lisääminen

Toiminnon avulla voidaan lisätä sähköpostiosotie estolistalle.

POST /v1/api/suppressions.{xml|json|php}

cURL esimerkki:

curl -i https://api.cmfile.net/v1/api/suppressions.json -H 'X-Access-Token:{ACCESS_TOKEN}' -H 'X-Request-Signature:{REQUEST_SIQNATURE}' -H 'X-Request-Timestamp: {TIMESTAMP}' -H "Accept: application/json; version=v1" -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; charset=utf-8
 
{
  "success": true,
  "message": "Suppression added"
}

Estolistan tiedot

Toiminnon avulla voidaan hakea estolistan sähköpostiosoitteet.

GET /v1/api/suppressions.{xml|json|php}

cURL esimerkki:

curl -i https://api.cmfile.net/v1/api/suppressions.json -H 'X-Access-Token:{ACCESS_TOKEN}' -H 'X-Request-Signature:{REQUEST_SIQNATURE}' -H 'X-Request-Timestamp: {TIMESTAMP}' -H "Accept: application/json; version=v1" -X GET

Oletettu vastaus (Json):

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
 
{
  "Results": [
    { 
      "email": "erkki@esimerkki.com",
      "reason": "deleted",
      "created":"2013-02-13 13:49:42", 
    },
    ...
  ],
}

Eston poistaminen

Toiminnon voidaan poistaa sähköpostiosoite estolistalta.

DELETE /v1/api/suppressions.{xml|json|php}?email=erkki@esimerkki.com

cURL esimerkki:

curl -i https://api.cmfile.net/v1/api/suppressions.json?email=erkki@esimerkki.com -H 'X-Access-Token:{ACCESS_TOKEN}' -H 'X-Request-Signature:{REQUEST_SIQNATURE}' -H 'X-Request-Timestamp: {TIMESTAMP}' -H "Accept: application/json; version=v1" -X DELETE

Oletettu vastaus (Json):

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
 
{
  "success": true,
  "message": "Suppression removed"
}

Aiheeseen liittyvät artikkelit

Kommentit

0 kommenttia

Kirjaudu sisään jättääksesi kommentin.