panelAdd()

bool panelAdd(array data, string duplicates)

The function panelAdd() creates a new entry in the List of Contacts, which can subsequently be used for sending mailings.

Note: If respondents shall sign up for the mailing list, the question type Opt-In for mailing list is usually better suited than panelAdd().

• data
  An array that allows the following keys:
  • 'email' / 'EMAIL' – Email address
  • 'email.cc' / 'CC' – Email CC
  • 'mobile' / 'PHONE' – Mobile phone number including the dialing code, e.g., +4916300000000
  • 'uid' – Unique ID
  • 'username' / 'USERNAME' – User name (for a login)
  • 'password' / 'PASS' – Password (for a login)
  • 'firstname' / 'FRSTNAME' – First name
  • 'lastname' / 'LASTNAME' – Last name/family name
  • 'sex' / 'GENDER' – Gender (m/w/Herr/Frau)
  • 'title' / 'TITLE' – Academic title
  • 'salutation' / 'ALTSALUT' – Complete salutation (instead of an automatically generated salutation)
  • 'language' / 'LANG' – Language (3-letter language code)
  • 'serial' / 'SERIAL' – Person ID (SERIAL)
  • 'subgroup' / 'SUBGROUP' – Subgroup
  • 'custom1' / 'CUSTOM1' – Custom field 1
  • 'custom2' / 'CUSTOM2' – Custom field 2
  • 'custom3' / 'CUSTOM3' – Custom field 3
  • 'custom4' / 'CUSTOM4' – Custom field 4
  • 'custom5' / 'CUSTOM5' – Custom field 5
  • 'privacy' / 'PRIVACY' – Privacy mode
    • 'id' – individual-related
    • 'ps' – pseudonym
    • 'af' – make anonymous when the interview is finished
    • 'as' – anonymous
  • 'expire' / 'VALID' – Expiry date, automatic deletion after this point in time (Unix timestamp)
• duplicates
  Handling of duplicate address entries, that is, of existing entries that have the same email address, mobile phone number, ID (UID) or the same user name.
  • 'import' – Create the address entry regardless of existing entries.
  • 'update' – Supplement an address entry that may already exist with the new data.

The function returns true if the entry could be created or updated, otherwise false.