Get Smart Campaign Rules
Returns all available trigger and filter rule types that can be used in smart campaign smart lists.
Responses
200 OK ResponseOfSmartCampaignRuleType
errors array of Error
Model Error
code string required Error code of the error. See full list of error codes here
message string required Message describing the cause of the error
requestId string result array of SmartCampaignRules
Model SmartCampaignRules
filters array of SmartCampaignRuleType
Filter rule types
Model SmartCampaignRuleType
id integer (int32) required Id of the rule type
name string required Name of the rule type
type string required Type of the rule
Values activity attribute
constraints array of RuleConstraint
Model RuleConstraint
result › filters › constraints
id integer (int32) Id of the constraint. Built-in constraints have negative ids
name string Name of the constraint
dataType string Data type of the constraint value
primary boolean Whether this is the primary constraint of the rule type
operator string Default operator of the constraint
dbAttrib boolean Whether the constraint is a person or company field
dbAttribId string Id of the person or company field
dbObject string Object the field belongs to
type string Field type of the constraint, for example standard or custom
triggers array of SmartCampaignRuleType
Trigger rule types
Model SmartCampaignRuleType
id integer (int32) required Id of the rule type
name string required Name of the rule type
type string required Type of the rule
Values activity attribute
constraints array of RuleConstraint
Model RuleConstraint
result › triggers › constraints
id integer (int32) Id of the constraint. Built-in constraints have negative ids
name string Name of the constraint
dataType string Data type of the constraint value
primary boolean Whether this is the primary constraint of the rule type
operator string Default operator of the constraint
dbAttrib boolean Whether the constraint is a person or company field
dbAttribId string Id of the person or company field
dbObject string Object the field belongs to
type string Field type of the constraint, for example standard or custom
predictiveFilters object Predictive filter rule types. Present when predictive attributes are available
success boolean warnings array of string Generated example
{
"errors": [
{
"code": "string",
"message": "string"
}
],
"requestId": "123",
"result": [
{
"filters": [
{
"id": 123,
"name": "Example name",
"type": "activity",
"constraints": [
{
"id": null,
"name": null,
"dataType": null,
"primary": null,
"operator": null,
"dbAttrib": null,
"dbAttribId": null,
"dbObject": null,
"type": null
}
]
}
],
"triggers": [
{
"id": 123,
"name": "Example name",
"type": "activity",
"constraints": [
{
"id": null,
"name": null,
"dataType": null,
"primary": null,
"operator": null,
"dbAttrib": null,
"dbAttribId": null,
"dbObject": null,
"type": null
}
]
}
],
"predictiveFilters": {}
}
],
"success": true,
"warnings": [
"string"
]
}Referenced models
Generated from swagger-asset.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.