An email campaign always has the following list of properties shown below. Access to a property value is done using dot notation. To get the value of the id property, you need to write campaign.id.

Here are the available properties.

General fields

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

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

campaign.template_id — data type: integer. A unique identifier of the template that will be sent.

campaign.dkim_id — data type: integer. A unique identifier of the DKIM key associated with the campaign. May be null.

campaign.domain_id — data type: integer. A unique identifier of the domain from which emails will be sent.

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

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

campaign.title — data type: string. The campaign title.

campaign.category_title — data type: string. The campaign category.

campaign.subject — data type: string. The email subject.

campaign.sender_name — data type: string. The sender’s name.

campaign.sender_email_username — data type: string. The sender’s email username (the part of the email address before the @ symbol).

campaign.source_type — data type: string. The source of subscribers for the campaign. Possible values: base (subscriber base) or direct (when subscribers are added to the campaign through other means).

campaign.source_base_id — data type: integer. The subscriber base ID if campaign.source_type has the value base. May be null.

campaign.source_expression — data type: string. An expression that will be evaluated for each subscriber before being added to this campaign if campaign.source_type has the value base. May be null.

campaign.is_active — data type: integer, possible values are 0 and 1. Indicates whether this campaign is active.