Email Integration
- 22 Feb 2024
- 2 Minutes to read
Email Integration
- Updated on 22 Feb 2024
- 2 Minutes to read
Article Summary
Share feedback
Thanks for sharing your feedback!
A user object is required to collect and process users’ email addresses, GDPR opt-ins and email opt-ins. Because Insider does not store any personal data on cookies or local storage, you must integrate a user object using Insider Object to gather the information necessary to send customer emails.
The following describes how to integrate user objects for email using Insider Object.
Sample code for User Object
window.insider_object = {
"user":{
"gdpr_optin":true,
"email":"jdoe@mailservice.com",
"email_optin":true,
"list_id":[1,3,5]
}
}Namespace
The code of Insider Object is as follows:
window.insider_object.*Code for user objects must be added under code for Insider Object.
User Object: Properties, definitions and code
User Object includes the user properties. User object can be implemented in all cases, including when the user is not logged in. When the user is not logged in, only the available properties will be filled in; keys without values will not be added to the object.
| Key | Property | Type | Definition |
|---|---|---|---|
| gdpr_optin* | GDPR Opt-in | Boolean | User's permission for any Insider campaign, data collection and processing. False = user will not see any Insider campaign or receive messages from any channel; True or empty = Insider is able to interact with the user through personalization campaigns. |
| email* | Email address | String | User's email address. You should replace the sample email address value in the object with your own variable that fetches the email addresses from your end. |
| email_optin* | Email Opt-in | Boolean | User's permission for marketing emails. True = emails allowed; False = emails not allowed |
| list_id | Newsletter Contact List ID | Numbers (Number array) | IDs of the newsletter contact lists (users are added in directly). You can see the ID of a contact list when you hover on the respective list on Audience > Contacts Management > Contact Lists. |
* Required field for this object.
If your company obtains your users' consent in compliance with the local regulations, make sure to pass the GDPR opt-in field to Insider. If you want to stop collecting and processing the data of an identified user, GDPR opt-in field should have the false value. Insider cannot be held liable if these obligations are not fulfilled and reserves the right to seek compensation from your company.
Once the user object is integrated into your website, you can provide Insider with the required email fields (email, gdpr_optin, email_optin) whenever a user:
- Logs in
- Subscribes to a newsletter (e.g. through an input box on the footer)
- Registers by providing their email (e.g. on the registration page)
your title goes here
- For users whose gdpr_optin field is not defined or is false: The user object and/or the respective field should not be filled in.
- For users whose email_optin field is not defined or is false: The user object and/or respective field can be filled in only if the gdpr_optin is true. If it is false, users will not receive emails.
If you passed the user’s uuid information while implementing the Insider Object, make sure the information is the same for both. For more information on uuid on user objects, see Insider Object Integration.
Checklist for any page where user object is present:
- Object window.insider_object.user returns on the page.
- All properties are filled in when user logs in.
Was this article helpful?