Outreach Campaigns (Full Update)
Description
See the Aerial Spec for more details.
File Naming Convention
TGEN_outreachCampaigns_fullupdate_2025-12_<optionalSuffix>.csv
importType:fullupdateapiVersion:2025-12
Columns
| Column Header | Description | Key Information | 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. | Max Length: 255 | string | No |
campaignCategory.name | Name of the campaign category | Max Length: 255 | 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] | Array element | mixed | 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].field.rules[0] | Array element | mixed | No | |
segment.rules[0].field.orderings | A list of named ordering configurations for this segment. Can be an identifier or an object. | array | No | |
segment.rules[0].field.orderings[0] | Array element | mixed | No | |
segment.rules[0].field.additionalFields | A list of additional fields to be included by default when previewing the segment. | array | No | |
segment.rules[0].field.additionalFields[0] | Array element | mixed | 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 | |
segment.orderings | A list of named ordering configurations for this segment. Can be an identifier or an object. | array | No | |
segment.orderings[0] | Array element | mixed | No | |
segment.orderings[0].name | The name of the ordering configuration. | string | No | |
segment.orderings[0].isDefault | Whether this ordering is the default for the segment. | boolean | No | |
segment.orderings[0].columns | An array of columns to define the sorting order. | array | No | |
segment.orderings[0].columns[0] | Array element | mixed | No | |
segment.orderings[0].columns[0].direction | The direction of the sort. | Allowed: ASC, DESC | string | No |
segment.orderings[0].columns[0].segmentRuleField | The UUID or external ID of the segment rule field to order by. | string | No | |
segment.orderings[0].columns[0].alias | An optional alias for the ordering column in the result set. If provided, the sorted column will be included in the output with this alias. | string | No | |
segment.additionalFields | A list of additional fields to be included by default when previewing the segment. | array | No | |
segment.additionalFields[0] | Array element | mixed | No | |
segment.additionalFields[0].segmentRuleField | The UUID or external ID of the segment rule field to include in the output. The rule field must have a table and column defined. | string | No | |
segment.additionalFields[0].alias | An optional alias for the additional field in the result set. If not provided, a default alias will be generated from the rule field’s name. | string | 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 | Allowed: DYNAMIC, STATIC | 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 | |
authoredByEmployee | UUID of the employee who authored this campaign, or expanded employee object | mixed | No | |
authoredByEmployee.externalId | Integrator provided unique identifier for the employee. Typically used to map a primary key from a third party system to the Tulip resource. | Max Length: 255 | string | Yes |
authoredByEmployee.disabled | Boolean dictating if employee is disabled (true or false) | boolean | No | |
authoredByEmployee.store | Unique Tulip identifier of the store the employee is associated with | Max Length: 36 | string | No |
authoredByEmployee.displayName | Name that will be displayed for the employee | string | No | |
authoredByEmployee.firstName | First name of the employee | Max Length: 255 | string | No |
authoredByEmployee.lastName | Last name of the employee | Max Length: 255 | string | No |
authoredByEmployee.emailAddress | Email address of the employee | Max Length: 255 | string | No |
authoredByEmployee.image | Image associated with the employee | string | No | |
authoredByEmployee.mobileNumber | Mobile number for the employee in E.164 standard | string | No | |
authoredByEmployee.jobTitle | Job title of the employee | Max Length: 255 | string | No |
authoredByEmployee.liveConnectAvailability | Boolean dictating whether live connect is available or not for the employee (true or false) | boolean | No | |
authoredByEmployee.attributes | Array of Attribute Values associated with this employee | array | No | |
authoredByEmployee.attributes[0] | Array element | mixed | No | |
authoredByEmployee.attributes[0].value | Value of the attribute, this will be any type casted to string but supports all basic types | mixed | Yes | |
authoredByEmployee.attributes[0].name | External ID of the attribute | Max Length: 255 | string | Yes |
authoredByEmployee.attributes[0].languageExternalId | External ID of the language, defaults to english | Max Length: 255 | string | Yes |
authoredByEmployee.attributes[0].type | Tulip Attribute Type | Allowed: string, boolean, integer | string | Yes |
authoredByEmployee.signature | Object containing the signature of the employee | mixed | No | |
authoredByEmployee.profile | Object containing the profile of the employee | mixed | No | |
authoredByEmployee.profile.phoneNumber | The profile phone number of the employee in E.164 format | string | No | |
authoredByEmployee.offlineNotificationConfig | Object containing the offline notification config of the employee | mixed | No | |
authoredByEmployee.offlineNotificationConfig.forwardingNumber | Forwarding number for the employee in E.164 standard | string | No | |
authoredByEmployee.offlineNotificationConfig.forwardingEnabled | Boolean dictating if employee has forwarding enabled (true or false) | boolean | No | |
authoredByEmployee.offlineNotificationConfig.forwardAllEnabled | Boolean dictating if all messages should be forwarded to the employee (true or false) | boolean | No | |
authoredByEmployee.offlineNotificationConfig.forwardLoggedOutEnabled | Boolean dictating if messages should be forwarded when employee is logged out (true or false) | boolean | No | |
authoredByEmployee.authUser | Object containing the user of the employee | mixed | No | |
authoredByEmployee.authUser.employee | Unique Tulip identifier of the employee | Max Length: 36 | string | No |
authoredByEmployee.authUser.username | The username of the employee | string | Yes | |
authoredByEmployee.authUser.password | The password of the employee | string | No | |
authoredByEmployee.authUser.disabled | Boolean dictating if user is disabled (true or false) | boolean | No | |
authoredByEmployee.authUser.roles | Array of role external ID’s | array | No | |
authoredByEmployee.authUser.roles[0] | Array element | Allowed: role_associate, role_manager, role_admin | string | No |
authoredByEmployee.samlNameId | If using SSO for authentication against a third party system, set the login username in this field if different than the value set in externalId. | string | 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] | Array element | mixed | 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. | Max Length: 32 | string | No |
templates[0].sms.template.subject | Subject of the Sms Template | Max Length: 160 | string | No |
templates[0].sms.template.name | Name of the Sms Template | Max Length: 160 | 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 | Max Length: 32 Min Length: 2 | string | No |
templates[0].sms.template.category | The category in which the Sms Template belongs | Max Length: 50 | string | No |
templates[0].sms.template.stores | List of associated Stores | array | No | |
templates[0].sms.template.stores[0] | Array element | mixed | No | |
templates[0].sms.template.storeGroup | N/A | mixed | No | |
templates[0].sms.template.isGlobal | Determines the visibility scope of the template. If true, the template is ‘Global’ and accessible by all stores automatically. If false, the template’s visibility is restricted to specific store or group assignments (if any). | boolean | 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. | Max Length: 32 | string | No |
templates[0].email.template.subject | Subject of the Sms Template | Max Length: 160 | string | No |
templates[0].email.template.name | Name of the Sms Template | Max Length: 160 | 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 | Max Length: 32 Min Length: 2 | string | No |
templates[0].email.template.category | The category in which the Sms Template belongs | Max Length: 50 | string | No |
templates[0].email.template.stores | List of associated Stores | array | No | |
templates[0].email.template.stores[0] | Array element | mixed | No | |
templates[0].email.template.storeGroup | N/A | mixed | No | |
templates[0].email.template.isGlobal | Determines the visibility scope of the template. If true, the template is ‘Global’ and accessible by all stores automatically. If false, the template’s visibility is restricted to specific store or group assignments (if any). | boolean | 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] | Array element | mixed | 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] | Array element | mixed | 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 | |
matchmakingRules[0].matchmakingRule.topic | Identifier or model of the topic this matchmaking rule belongs to. | object | No |
Sample CSV
See the following outreachCampaigns CSV sample file.