Email megjelölése olvasottként

Előfeltételek

• Létre kell hozni az API kapcsolathoz egy Service account-ot
  • Service account kezelés

Minden API végpont hívásához a megfelelő service account adatait kell megadni az authentikációban, az email küldő API-val azonos módon.

Email megjelölése olvasottnak

Az email-eket az azonosítójuk ismeretében lehet olvasottnak megjelölni. Ehhez a következő API végpontot kell meghívni:

PATCH https://app.forwardhub.com/client/emails/EMAILID/opened

Nincs request body-ban küldendő adat.

Ez a hívás az SMTP szolgáltató által visszaküldött open eseményt szimulálja és ugyanazokat a folyamatokat indítja el (statisztikázás, esemény küldése külső Webb & Flow rendszereknek, stb), mintha a címzett az eredeti levelet nyitotta volna meg a levelező kliensében. API hívás esetén az esemény időpontja mindig az API hívás időpontja lesz, azaz nem lehet olyan hívást indítani, ami egy múltbeli időpontra rakja le az open eseményt.

Alap esetben az API-n keresztül beküldött eseményt csak akkor dolgozza fel a rendszer, ha még nem lett megnyitva az email, azaz ha többször meg van hívva az API ugyanarra az email-re, akkor nem fog növekedni a megnyitások száma és az email log-jában sem jelennek meg az újabb események, cserébe ilyenkor gyorsabban lefut az API hívás.

Amennyiben mindenképpen szükség van az összes hívás log-olására, be lehet kapcsolni a forceUpdate paraméterrel, ebben az esetben nem ellenőrzi a rendszer, hogy az adott email meg lett-e már nyitva korábban:

PATCH https://app.forwardhub.com/client/emails/EMAILID/opened?forceUpdate=1

Az API sikeres hívás esetén ugyanazt a választ adja, mint az Email lekérő API , mindenképpen az esetleges csatolmányok tartalma nélkül.