Poradnik - Dokumentacja API

Webhook do wypisania się z mailingu

Istnieje możliwość aktualizacji danych respondenta w bazie obiorców w celach zablokowania jego adresu do ponownych wysyłek. Webhook to nic innego jak URL wywoływany za pomocą innego systemu informatycznego lub otwierany w zwykłej przeglądarce.

Postać adresu URL jest następująca:

https://www.webankieta.pl/webhooks/[id_account]‌/[webhook_key]‌‌/[webhook_auth]/unsubscribe?dodatkowe_parametry

Dodatkowe parametry to:

  • email – adres e-mail, który blokujemy na danym koncie.

Więcej parametrów nie jest potrzebnych. Bo blokujemy wysyłkę maila dla tego konta.

Przykładowa postać URL-a z dodatkowymi parametrami wysyłanymi jako GET to:

https://www.webankieta.pl/webhooks/387487/TUwNjNDg3M/84b750d6956f02503015938fc38bfe36/unsubscribe?email=a.kowalski@webankieta.pl

W przypadku poprawnego wypisania adresu e-mail z mailingu otrzymamy taki komunikat:

{"type":"success","msg":"E-mail has been unsubscribed"}

Ważne!
W przypadku wpisania błędnego adresu e-mail otrzymasz zwrotnie błąd (invalid e-mail address). 
Natomiast, gdy adres e-mail został już dodany do adresów zablokowanych – otrzymasz zwrotnie komunikat (e-mail has been unsubscribed)

Czy ten artykuł był pomocny?

Dziękujemy za udzielenie odpowiedzi