Outreach Campaigns (Full Update)
File Naming Convention
TGEN_outreachCampaigns_fullupdate_2025-08_<optionalSuffix>.csv
importType:fullupdateapiVersion:2025-08
Columns
| Column Header | Description | Type | Required |
|---|---|---|---|
externalId | External identifier for the campaign | string | No |
name | Name of the campaign | string | No |
description | Description of the campaign | string | No |
campaignType | Type of the campaign. If in test mode, the campaign will run as expected but will mock sending messages. | mixed | No |
campaignCategory | ID or object of the campaign category this campaign is part of | mixed | No |
campaignCategory.externalId | Integrator provided unique identifier for the campaign category. Typically used to map a primary key from a third party system to the Tulip resource. | string | No |
campaignCategory.name | Name of the campaign category | string | No |
segment | ID or object of the segment associated with the campaign | mixed | No |
segment.externalId | External identifier of the segment | string | No |
segment.name | Name of the segment | string | No |
segment.description | Description of the segment | string | No |
segment.type | Type of the segment | mixed | No |
segment.operator | Operator used to combine segment rules | mixed | No |
segment.isTemplate | Whether or not this segment can be used as a template when creating a campaign | boolean | No |
segment.rules | List of associated rules for this segment | array | No |
segment.rules[0].externalId | External identifier of the segment rule | string | No |
segment.rules[0].segment | Identifier of the segment this rule belongs to | string | No |
segment.rules[0].fieldSource | Source of the field used in the rule | mixed | No |
segment.rules[0].field | Identifier of the field or segment used in the rule | object | No |
segment.rules[0].field.externalId | External identifier of the segment | string | No |
segment.rules[0].field.name | Name of the segment | string | No |
segment.rules[0].field.description | Description of the segment | string | No |
segment.rules[0].field.type | Type of the segment | mixed | No |
segment.rules[0].field.operator | Operator used to combine segment rules | mixed | No |
segment.rules[0].field.isTemplate | Whether or not this segment can be used as a template when creating a campaign | boolean | No |
segment.rules[0].field.rules | List of associated rules for this segment | array | No |
segment.rules[0].comparator | Enum comparator used in the rule. This matches the available enum values for the datatype of the segmetn rule field. If the source is a segment, the available fields match a Boolean rule field. | string | No |
segment.rules[0].value | Value used in the rule. This is a stringified JSON object for the shape the value should be in based on the comparator. | string | No |
segment.rules[0].negateQuery | Whether to negate the query for this rules field. | boolean | No |
storeGroup | UUID or external ID of the assigned store group | mixed | No |
storeGroup.externalId | The external identifier of the store group | string | No |
storeGroup.type | Type of the store group | string | No |
storeGroup.name | Name of the store group | string | No |
storeGroup.description | Description of the store group | string | No |
storeGroup.rules | Rules for membership in the store group. Valid keys: countryCode, disabled, district and storeType | object | No |
restrictions | N/A | mixed | No |
restrictions.messageRestrictionNumDays | Override for number of days to restrict sending another message to the customer if they fall back into the particular segment | integer | No |
restrictions.messageRestrictionSendOnce | Restrict sending more than one message to a customer during a single campaign | boolean | No |
restrictions.messageRestrictionNumDaysAnyOutreach | Override for number of days to restrict sending another message to the customer if they fall back into the particular segment | integer | No |
restrictions.messageExpiryNumDays | Number of days from when the campaign was evaluated and the message was dispatched to be invalidated and not sent. | integer | No |
schedule | N/A | mixed | No |
schedule.sendWindowStartTime | The start time of the daily window during which messages can be sent, in HH:MM:SS format. | string | No |
schedule.sendWindowEndTime | The end time of the daily window during which messages can be sent, in HH:MM:SS format. | string | No |
schedule.timezone | The IANA timezone identifier for the send window. | string | No |
schedule.startDate | Date for when the campaign is scheduled to run in Z-normalized RFC3339 format | string | No |
schedule.endDate | Date for when the campaign is scheduled to end on in Z-normalized RFC3339 format | string | No |
schedule.runSchedule | The date and time the campaign should be evaluated on in crontab notation https://crontab.guru/ | string | No |
templates | Messaging configuration for the campaign | array | No |
templates[0].sms | N/A | mixed | No |
templates[0].sms.messageType | Message type corresponding to the outreach method being seng | mixed | No |
templates[0].sms.template | Uuid or External ID of the sms/email template | mixed | No |
templates[0].sms.template.externalId | Integrator provided unique identifier for the Sms Template. Typically used to map a primary key from a third party system to the Tulip resource. | string | No |
templates[0].sms.template.subject | Subject of the Sms Template | string | No |
templates[0].sms.template.name | Name of the Sms Template | string | No |
templates[0].sms.template.content | Content of the Sms Template | string | Yes |
templates[0].sms.template.languageCode | The language code of the Sms Template | string | No |
templates[0].sms.template.category | The category in which the Sms Template belongs | string | No |
templates[0].sms.template.stores | List of associated Stores | array | No |
templates[0].sms.sender | Sender of the outreach job. Type of string corresponds to what the message type is. | string | No |
templates[0].sms.priority | Priority of messaging channel when determining what channel to send to the customer. Not required if only one CampaignTemplate is specified for the configuration. | integer | No |
templates[0].email | N/A | mixed | No |
templates[0].email.messageType | Message type corresponding to the outreach method being seng | mixed | No |
templates[0].email.template | Uuid or External ID of the sms/email template | mixed | No |
templates[0].email.template.externalId | Integrator provided unique identifier for the Sms Template. Typically used to map a primary key from a third party system to the Tulip resource. | string | No |
templates[0].email.template.subject | Subject of the Sms Template | string | No |
templates[0].email.template.name | Name of the Sms Template | string | No |
templates[0].email.template.content | Content of the Sms Template | string | Yes |
templates[0].email.template.languageCode | The language code of the Sms Template | string | No |
templates[0].email.template.category | The category in which the Sms Template belongs | string | No |
templates[0].email.template.stores | List of associated Stores | array | No |
templates[0].email.sender | Sender of the outreach job. Type of string corresponds to what the message type is. | string | No |
templates[0].email.priority | Priority of messaging channel when determining what channel to send to the customer. Not required if only one CampaignTemplate is specified for the configuration. | integer | No |
templates[0].followup | N/A | mixed | No |
templates[0].followup.title | Title for the followup. | string | No |
templates[0].followup.description | Description for the followup. | string | No |
templates[0].followup.type | UUID or External ID of the Followup type | mixed | No |
templates[0].followup.daysUntilDueDate | Number of days until the followup is due | integer | No |
templates[0].followup.timeDue | Time for when the campaign is scheduled to end on in Z-normalized RFC3339 format | string | No |
segmentRuleValueOverrides | List of overrides for the values of the associated rules for the segment | array | No |
segmentRuleValueOverrides[0].segmentRule | Identifier of the segment rule to override the value for | string | No |
segmentRuleValueOverrides[0].value | Value used in the rule. This is a string representation of the data. | string | No |
segmentRuleValueOverrides[0].comparator | Comparator used in the rule | string | No |
matchmakingRules | List of associated matchmaking rules for this campaign | array | No |
matchmakingRules[0].sortOrder | The sort order for the matchmaking rule in the campaign context. | integer | No |
matchmakingRules[0].matchmakingRule | UUID or External ID of the Matchmaking Rule. | mixed | No |
Sample CSV
See the following outreachCampaigns CSV sample file.