It is possible to update respondent data in the recipient database in order to block their address from future mailings. A Webhook is simply a URL called by another IT system or opened in a standard browser.

The URL address format is as follows:

https://app.customerhero.com/webhooks/[id_account]‌/[webhook_key]‌‌/[webhook_auth]/unsubscribe?additional_parameters

Additional parameters are:

  • email – the e-mail address we are blocking on a given account.

No additional parameters are needed, because we are blocking email sending for this account.

An example URL format with additional parameters sent as GET is:

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

In the case of successfully unsubscribing the e-mail address from the mailing, we will receive this message:

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


Important!
If you enter an incorrect e-mail address, you will receive an error in return (invalid e-mail address).
However, if the e-mail address has already been added to the blocked addresses – you will receive a message in return (e-mail has been unsubscribed)