In this documentation we sometimes refer to the "Codes Table": it provides a list of IDs that are needed in several API calls:
- List IDs
- List GUIDs
- Group IDs
- Recipient field codes
Recipient fields, also called personal data fields, are defined in your MailUp admin console under Settings > Account settings > Recipient Fields. By default, you can define up to 39 custom fields.
The Codes Table can be accessed in your MailUp admin console by navigating to Settings > Advanced settings > Developer's corner > Codes Table. Here is an example on the section that describes the personal data fields.
Some IP calls require the List GUID. You can locate it by navigating to the Settings > Advanced settings > Developer's corner > Codes table page in your MailUp admin console.
Here is an example of how this page looks like.
Personal data fields
Personal data fields (also called recipient fields or dynamic fields) store information about your recipients. There are three types of fields:
- the recipient fields that you may have configured in your account,
- the mandatory sender information that you should have set with the onboarding wizard or when configuring a new MailUp list,
- a set of system defined, built-in dynamic fields (see table below)
Here is a table with a list of system-defined dynamic fields. Dynamic because they can use as merge tags in the body of an email message (and therefore also in links included in the message).
|[email]||The recipient's email address|
|[prefix]||The recipient's phone number's international prefix|
|[number]||The recipient's mobile phone number|
|[idu]||MailUp-defined unique identifier for that recipient|
|[_idoptin]||Same as above|
|[_hash]||MailUp internal GUID for that specific recipient|
|[_subemail]||Email recipient's subscription date|
|[_subsms]||SMS recipient's subscription date|
|[_ip_req_sub]||IP address recorded for the subscription request|
|[_ip_conf_sub]||IP address recorded for the subscription confirmation request|
|[_currentday]||Integer for current day (e.g. 22).|
|[_currentdayname]||String for current day (e.g. Wednesday)|
|[_currentmonth]||Integer for current month (e.g. 4)|
|[_currentmonthname]||String for current month (e.g. April)|
|[_currentyear]||Integer for current year (e.g. 2017)|