Kampaň rozesílky má vždy následující seznam vlastností, který je uveden níže. Přístup k hodnotě vlastnosti probíhá pomocí tečky. Chcete-li získat hodnotu vlastnosti id, je třeba napsat campaign.id
Zde jsou vlastnosti, které lze získat.
Obecná pole
campaign.id — datový typ: celé číslo. Jedinečný identifikátor kampaně, v čase se nemění.
campaign.project_id — datový typ: celé číslo. Jedinečný identifikátor projektu, v němž byla kampaň vytvořena, v čase se nemění.
campaign.template_id — datový typ: celé číslo. Jedinečný identifikátor šablony, která se bude odesílat.
campaign.dkim_id — datový typ: celé číslo. Jedinečný identifikátor klíče DKIM, který je propojen s kampaní. Může být null.
campaign.domain_id — datový typ: celé číslo. Jedinečný identifikátor domény, jejímž jménem se budou e-maily odesílat.
campaign.created_at — datový typ: celé číslo. Je to časová značka ve formátu unix timestamp, kdy byla kampaň vytvořena.
campaign.updated_at — datový typ: celé číslo. Je to časová značka ve formátu unix timestamp, kdy byla kampaň naposledy aktualizována.
campaign.title — datový typ: řetězec. Název kampaně.
campaign.category_title — datový typ: řetězec. Kategorie kampaně.
campaign.subject — datový typ: řetězec. Předmět e-mailu.
campaign.sender_name — datový typ: řetězec. Jméno odesílatele.
campaign.sender_email_username — datový typ: řetězec. E-mailové jméno odesílatele (část e-mailu před znakem @).
campaign.source_type — datový typ: řetězec. Zdroj odběratelů pro kampaň. Možné hodnoty: base (databáze odběratelů) nebo direct (když se odběratelé dostávají do kampaně jinými cestami).
campaign.source_base_id — datový typ: celé číslo. ID databáze odběratelů, pokud campaign.source_type má hodnotu base. Může být null.
campaign.source_expression — datový typ: řetězec. Výraz, který se bude kontrolovat pro každého odběratele před přidáním do této kampaně, pokud campaign.source_type má hodnotu base. Může být null.
campaign.is_active — datový typ: celé číslo, možné hodnoty 0 a 1. Odpovídá za aktivitu této kampaně.