SMS Templates (Full Update)
Description
If the UUID of the Sms Template Resource exists in the system, or no UUID is provided and an External ID exists, then an update is performed. Otherwise, the resource is created.
See the Aerial Spec for more details.
File Naming Convention
TGEN_smsTemplates_fullupdate_2025-08_<optionalSuffix>.csv
importType:fullupdateapiVersion:2025-08
Columns
| Column Header | Description | Key Information | Type | Required |
|---|---|---|---|---|
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 |
subject | Subject of the Sms Template | Max Length: 160 | string | No |
name | Name of the Sms Template | Max Length: 160 | string | No |
content | Content of the Sms Template | string | Yes | |
languageCode | The language code of the Sms Template | Max Length: 32 Min Length: 2 | string | No |
category | The category in which the Sms Template belongs | Max Length: 50 | string | No |
stores | List of associated Stores | array | No | |
stores[0] | Array element | mixed | No | |
stores[0].externalId | Integrator provided unique identifier for the store. Typically used to map a primary key from a third party system to the Tulip resource. | Max Length: 255 | string | Yes |
stores[0].disabled | Boolean dictating if store is disabled (true or false) | boolean | No | |
stores[0].name | Name of the store | string | Yes | |
stores[0].businessEntityName | Business entity name of the store | string | No | |
stores[0].address | Address of the store | string | Yes | |
stores[0].city | City of the store | string | No | |
stores[0].postalCode | Postal code of the store | string | Yes | |
stores[0].zoneCode | Zone code of the store: The ISO-3166-2 region code (including the country code portion) for the state/province/region | string | No | |
stores[0].countryCode | Country ISO code in ISO-3166-1 alpha-3 format | string | Yes | |
stores[0].latitude | Latitude of the store | string | No | |
stores[0].longitude | Longitude of the store | string | No | |
stores[0].taxDivision | Tax Division of the store | string | No | |
stores[0].taxProvider | Tax Provider of the store - use an ID from the tax provider API | string | No | |
stores[0].remotePayAdyenMerchantAccount | Remote Pay Adyen Merchant Account | string | No | |
stores[0].onlineStore | Online store associated with this store. | string | No | |
stores[0].emailAddress | Email Address of the store | string | No | |
stores[0].phoneNumber | Phone number of the store (E.164 standard) | string | No | |
stores[0].mobilePhoneNumber | Mobile phone number of the store (E.164 standard) | string | No | |
stores[0].receiptLanguageCode | Language code to use for receipts from this store | string | No | |
stores[0].district | UUID of the district associated with this store. | string | No | |
stores[0].timeZone | Time zone in IANA format this store is in | string | No | |
stores[0].settings | N/A | mixed | Yes | |
stores[0].settings.runnerEnabled | Boolean dictating whether runner is enabled for the store (true or false) | boolean | No | |
stores[0].settings.liveConnectEnabled | Boolean dictating if store has live connect enabled (true or false) | boolean | No | |
stores[0].settings.fulfillFromMultipleStoresEnabled | Boolean dictating if store is fulfilled from multiple stores (true or false) | boolean | No | |
stores[0].settings.conditionalOrderFlowEnabled | Boolean dictating if conditional order flow is enabled for the store (true or false) | boolean | No | |
stores[0].settings.twilioCallingEnabled | Boolean dictating if Twilio calling is enabled for the store (true or false) | boolean | No | |
stores[0].settings.clientelingLoginEnabled | Boolean dictating if this store is able to be logged into for the Clienteling app | boolean | No | |
stores[0].settings.checkoutLoginEnabled | Boolean dictating if this store is able to be logged into for the Checkout app | boolean | No | |
stores[0].settings.useStoreDetailsToSendEmail | Boolean dictating whether store name and email will be used as for the From/Sender details when sending an email (true or false). If false, the associate name and email will be used | boolean | No | |
stores[0].settings.pendingCustomerFlowEnabled | Whether pending customer flow is enabled for this store or not | Allowed: Default, Enabled, Disabled | string | No |
stores[0].hours | N/A | mixed | Yes | |
stores[0].hours.monday | N/A | mixed | Yes | |
stores[0].hours.monday.open | Time the store opens for the day (local timezone, 24-hour format) | string | No | |
stores[0].hours.monday.close | Time the store closes for the day (local timezone, 24-hour format) | string | No | |
stores[0].hours.tuesday | N/A | mixed | Yes | |
stores[0].hours.tuesday.open | Time the store opens for the day (local timezone, 24-hour format) | string | No | |
stores[0].hours.tuesday.close | Time the store closes for the day (local timezone, 24-hour format) | string | No | |
stores[0].hours.wednesday | N/A | mixed | Yes | |
stores[0].hours.wednesday.open | Time the store opens for the day (local timezone, 24-hour format) | string | No | |
stores[0].hours.wednesday.close | Time the store closes for the day (local timezone, 24-hour format) | string | No | |
stores[0].hours.thursday | N/A | mixed | Yes | |
stores[0].hours.thursday.open | Time the store opens for the day (local timezone, 24-hour format) | string | No | |
stores[0].hours.thursday.close | Time the store closes for the day (local timezone, 24-hour format) | string | No | |
stores[0].hours.friday | N/A | mixed | Yes | |
stores[0].hours.friday.open | Time the store opens for the day (local timezone, 24-hour format) | string | No | |
stores[0].hours.friday.close | Time the store closes for the day (local timezone, 24-hour format) | string | No | |
stores[0].hours.saturday | N/A | mixed | Yes | |
stores[0].hours.saturday.open | Time the store opens for the day (local timezone, 24-hour format) | string | No | |
stores[0].hours.saturday.close | Time the store closes for the day (local timezone, 24-hour format) | string | No | |
stores[0].hours.sunday | N/A | mixed | Yes | |
stores[0].hours.sunday.open | Time the store opens for the day (local timezone, 24-hour format) | string | No | |
stores[0].hours.sunday.close | Time the store closes for the day (local timezone, 24-hour format) | string | No | |
stores[0].storeType | Unique Tulip identifier of the store type | Max Length: 36 | mixed | No |
stores[0].storeType.externalId | Integrator provided unique identifier for the store. Typically used to map a primary key from a third party system to the Tulip resource. | Max Length: 255 | string | Yes |
stores[0].storeType.name | Name of the store type | Max Length: 255 | string | Yes |
stores[0].attributes | Array of Attribute Values associated with this store | array | No | |
stores[0].attributes[0] | Array element | mixed | No | |
stores[0].attributes[0].value | Value of the attribute, this will be any type casted to string but supports all basic types | mixed | Yes | |
stores[0].attributes[0].name | External ID of the attribute | Max Length: 255 | string | Yes |
stores[0].attributes[0].languageExternalId | External ID of the language, defaults to english | Max Length: 255 | string | Yes |
stores[0].attributes[0].type | Tulip Attribute Type | Allowed: string, boolean, integer | string | Yes |
stores[0].catalogs | Array of catalog IDs (UUIDs or External IDs) associated with this store | array | No | |
stores[0].catalogs[0] | Array element | string | No | |
storeGroup | N/A | 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 |
Sample CSV
See the following smsTemplates CSV sample file.