SmartCampaignResponseWithFlow
23 properties55 including nested8 operations use this
Properties
id integer (int32) required Id of the smart campaign (system managed)
name string required Name of the smart campaign
description string required Description of the smart campaign
type string required Type of the smart campaign. Batch: has at least one filter and no triggers. Trigger: has at least one trigger. Default: has no smart list rules
Values batch default trigger
isSystem boolean required Whether smart campaign is system managed. Defaults to false
isActive boolean required Whether smart campaign is active. Defaults to false
isRequestable boolean required Whether smart campaign is requestable (is active and contains 'Campaign is Requested' trigger with Source of 'Web Service API'). Defaults to false
recurrence Recurrence required
Recurrence schedule of batch smart campaign
Model Recurrence
startAt string (date-time) required Datetime of the first scheduled campaign to run. Required if setting recurrence. Not required to create a smart campaign that has no recurrence
endAt string (date-time) required Datetime after which no further runs will be automatically scheduled
intervalType string required Recurrence interval. Not required to create a smart campaign that has no recurrence
Values Daily Weekly Monthly
interval integer (int32) required Number of interval units between recurrences
weekdayOnly boolean required Only run smart campaign on weekdays. May only be set if intervalType is 'Daily'. Defaults to false
weekdayMask array of string required String array of empty or one or more of 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'. May only be set if intervalType is 'Weekly'
dayOfMonth integer (int32) required Day of the month to recur. Permissible range 1-31. May only be set if intervalType is 'Monthly' and dayOfWeek and weekOfMonth are unset.
dayOfWeek string (int32) required Day of the week to recur. May only be set if dayOfMonth is not set, and weekOfMonth is set
Show all 7 values
Monday Tuesday Wednesday Thursday Friday Saturday Sunday
weekOfMonth integer (int32) required Week of the month to recur. Permissible range 1-4. May only be set if dayOfMonth is not set, and dayOfWeek is set
qualificationRuleType string required Type of qualification rule. Defaults to 'once'
Values once any interval
qualificationRuleInterval integer required Interval of qualification rule. Only set when qualificationRuleType is 'interval'
qualificationRuleUnit string required Unit of measure of qualification rule. Only set when qualificationRuleType is 'interval'
Values hour day week month
maxMembers integer (int32) required Smart campaign membership limit
isCommunicationLimitEnabled boolean required Whether smart campaign communication limit is enabled (i.e. block non-operational emails). Defaults to false
smartListId integer (int32) required Id of the smart campaign's child smart list
flowId integer (int32) required Id of the smart campaign's child flow
parentProgramId integer (int32) Parent program Id. Present if smart campaign is under program or nested folder
folder Folder required
JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'
Model Folder
id integer (int32) required Id of the folder
type string required Type of folder
Values Folder Program
createdAt string (date-time) required Datetime when the smart campaign was created
updatedAt string (date-time) required Datetime when the smart campaign was most recently updated
workspace string required Name of the smart campaign workspace
computedUrl string URL to asset in Marketo Engage
status string required Status of smart campaign
Show all 7 values
Inactive Single Run Invalid Recurring Run Active Requested Never Run
flow Flow
Flow steps of the campaign, included when includeFlowSteps is true
Model Flow
steps array of FlowStep
Model FlowStep
id integer (int32) required Id of the flow step, used in flow step mutation endpoints
activityTypeId integer (int32) required Id of the flow step action type
activityTypeName string required Name of the flow step action type
stepChoice array of FlowStepChoice
Model FlowStepChoice
flow › steps › stepChoice
id integer (int32) required Id of the choice, used in choice mutation endpoints
default boolean required Whether this is the default choice for the flow step
attributes array of FlowStepChoiceAttribute
Model FlowStepChoiceAttribute
flow › steps › stepChoice › attributes
id integer (int32) required Id of the attribute
activityTypeAttribId integer (int32) Id of the activity type attribute definition
name string required Name of the attribute
dataType string Data type of the attribute value
value string Value of the attribute
format string Display format of the value
primary boolean Whether this is the primary attribute of the flow step
rule FlowStepChoiceRule
Condition for the choice, present on non-default choices
Model FlowStepChoiceRule
flow › steps › stepChoice › rule
name string Name of the field tested by the condition
operator string Condition operator, for example 'is', 'is not', 'contains'
ruleType string Type of the condition
Values Activity Attribute
ruleTypeId integer (int32) Id of the activity type or field tested by the condition
values array of string Values the condition matches
Referenced models
Used by
Smart Campaigns
POSTAdd Flow StepPOSTAdd Step ChoiceGETGet Smart Campaign by IdGETGet Smart Campaign by NamePOSTRemove Flow StepPOSTRemove Flow Step ChoicePOSTReorder Flow Step ChoicePOSTUpdate Flow Step ChoiceGenerated from swagger-asset.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.