A subscriber always has the following list of properties shown below. Access to a property value is performed using dot notation. To get the value of the id property, you need to write subscriber.id.

Here are the available properties.

General fields

subscriber.id — data type: integer. A unique subscriber identifier that does not change over time.

subscriber.project_id — data type: integer. A unique identifier of the project in which the subscriber was created; does not change over time.

subscriber.base_id — data type: integer. A unique identifier of the subscriber base.

subscriber.is_active — data type: integer, possible values are 0 and 1. Indicates whether this subscriber’s subscription to mailings in this subscriber base is active.

subscriber.created_at — data type: integer. A timestamp in Unix timestamp format indicating when the subscriber was created.

subscriber.updated_at — data type: integer. A timestamp in Unix timestamp format indicating when the subscriber was last updated.

subscriber.email — data type: string. The subscriber’s email address.

subscriber.phone — data type: string. The subscriber’s phone number.

subscriber.first_name — data type: string. The subscriber’s first name.

subscriber.last_name — data type: string. The subscriber’s last name.

subscriber.gender — data type: string. The subscriber’s gender. Possible values: male for male, female for female, empty string if the data is not specified.

Address (for example, residence or delivery)

subscriber.address_country — data type: string. ISO 3166-1 alpha-2 country code (two letters). May be null.

subscriber.address_city — data type: string. Arbitrary city / locality name. May be null.

subscriber.address_state — data type: string. State / region / province. May be null.

subscriber.address_zip — data type: string. Postal code. May be null.

subscriber.address_line1 — data type: string. First address line. May be null.

subscriber.address_line2 — data type: string. Second address line. May be null.

subscriber.address_line3 — data type: string. Third address line. May be null.

Additional data

subscriber.birthday_year — data type: integer. Year of birth. May be null.

subscriber.birthday_month — data type: integer. Possible values from 1 to 12. Month of birth. May be null.

subscriber.birthday_day — data type: integer. Possible values from 1 to 31. Day of birth. May be null.

subscriber.birthday_unix — data type: integer. Date of birth in Unix timestamp format. May be null.

subscriber.client_user_id — data type: string. Subscriber ID in the client’s system, an arbitrary value up to 100 characters long. May be null.

subscriber.custom_field1 — data type: string. Contains an arbitrary value at the client’s discretion. May be null.

subscriber.custom_field2 — data type: string. Contains an arbitrary value at the client’s discretion. May be null.

subscriber.custom_field3 — data type: string. Contains an arbitrary value at the client’s discretion. May be null.