All Collections
API Documentation
Webhook to unsubscribe from mailing
Webhook to unsubscribe from mailing
Artur Zbiejcik avatar
Written by Artur Zbiejcik
Updated over a week ago

It is possible to update the respondent's data in the recipient database in order to block their address for repeated mailings. A webhook is a URL requested using another IT system or opened in an ordinary browser.

The form of the URL is as follows:[id_account]β€Œ/[webhook_key]β€Œβ€Œ/[webhook_auth]/unsubscribe?additional_parameters

Additional parameters are as follows:

  • email - email address that you block on a given account.

No more parameters are needed. Because you are blocking sending of emails for this account.

An example form of a URL with additional parameters sent as GET is:

If the email address is correctly unsubscribed from the mailing, you will receive the following message:

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


If you enter an incorrect email address, you will receive an error (invalid e-mail address).

However, when the email address has been added to the blocked addresses, you will receive a message (e-mail has been unsubscribed)

Did this answer your question?