Messaging Lists
Subscribe and unsubscribe identifiers from messaging Lists.
We are no longer updating this site. For user documentation, please go to User Docs. For developer documentation, please go to Developer Docs. If you have any questions or feedback, please submit a ticket.
Messaging Lists allow you to group customers for the purposes of tracking their communication preferences. For example, allowing customers to subscribe to your company newsletter or for holiday news.
Zaius does not require customers to be subscribed to a List to receive emails.
Single List
Multiple Lists
Including Additional Fields
// subscribe [email protected] to newsletter list
zaius.subscribe({list_id: 'newsletter', email: '[email protected]'});
// unsubscribe [email protected] from newsletter list
zaius.unsubscribe({list_id: 'newsletter', email: '[email protected]'});
// subscribe [email protected] to three lists at once
zaius.subscribe({
list_id: ["newsletter", "promotion", "product_update"],
});
// unsubscribe [email protected] from multiple lists at once
zaius.unsubscribe({
list_id: ["newsletter", "product_update"],
});
zaius.subscribe({
// subscribe Johnny to all lists
list_id: ["newsletter", "promotion", "product_update"],
// update Johnny's record to include his full name
first_name: "Johnny",
last_name: "Zaius",
// store information on the subscribe events
event_custom_field: "my custom value",
custom_number_field: 123
});
// zaius.unsubscribe also fully supports this syntax.

Events

Zaius generates events automatically for the purposes of analytics and auditing. The events are structured as follows:
Event Type
Event Action
List ID
Date / Time
list
subscribe
newsletter
123456
list
unsubscribe
newsletter
123456
Copy link