Skip to main content

CampaignAttributes

A list of attributes used for searching Campaigns. At least the

matching mode and another attribute should be set, or

findCampaignsBy will return an error.

AttributesTypeDescriptionOptionalDefault
matchingModeAttributeMatchingModeWheter to match any or all of the contained attributesNo
identifiersLookupIdentifiersA list of campaign identifiersYes
aliasLookupFieldA string to match against a campaign’s aliasYes
messageIdentifiersLookupIdentifiersA list of message identifiersYes
startDateLookupDateA date interval for the campaign’s start dateYes
deliveryStatusDeliveryStatusCampaign statusYes
campaignTypeCampaignTypeCampaign typeYes
deferredbooleanDeferred campaignyes
sourceFiltersLookupIdentifiersA list of subscriber source filter identifiersYes
nameLookupFieldA string to match against a campaign’s nameYes
subjectLookupFieldA string to match against a campaign’s subjectYes
noteLookupNoteA string to match against a campaign’s notesYes
categoryIdintA campaign categoryYes
parentIdintA campaign’s parentYes
triggerablebooleanTriggerable campaignYes