» Objects » List

List object

The structure of the List object

Fields

ID
Integer
The list's ID
DESCRIPTION
String
The description of the list
REMOVE_TITLE
String
Title of the removal page
SITE_NAME
String
The name of the list's website
SITE_URL
String
URL of the list's website
LOGO
String
URL to the list's logo
SENDER_NAME
String
The name of the sender of the list's emails
SENDER_EMAIL
String
The email address of the sender of the list's emails
SENDER_ADDRESS
String
The physical address of the sender of the list's emails
NAME
String
The List's name in english
AUTH_MAIL_SUBJECT
String
Subject of the authentication email
AUTH_MAIL_BODY
String
Body of the authenticaion email
AUTH_MAIL_LINK
String
Text of the authentication link
AUTH_MAIL_DIR
Integer
Language of the authentication link
0 - Hebrew
1 - English
Value: 0, 1
AUTH_MAIL_PAGE
String
"Thank You" page for first subscription
AUTH_MAIL_FORM
Boolean
Double subscription for subscription from a form
AUTH_MAIL_MANUAL
Boolean
Double subscription for manual subscription
EMAIL_NOTIFY
Array
An array of email addresses to be notified when a subscriber joins / leaves the list
AUTOMATION
Array
An array of List IDs to be used for Automation
EMPTY_LIST
Boolean
If set to true, the list will be EMPTIED. All of the list's subscribers will be deleted