File Format - Outreach SMS
Outreach SMS File Format
The Outreach SMS file allows integrators to send raw SMS messages through Tulip’s Outreach system. Each row in the CSV represents a single SMS message to be sent.
The first line of an Outreach SMS CSV file must be the header row. Each subsequent row creates a separate outreach job.
File Prefix: TOS
Feature Gate: The environment must have outreach-plus enabled; otherwise, the file will fail to upload any records successfully.
Spec
The following table shows the accepted CSV columns for the Outreach SMS entity.
| CSV Header | Data Type | Required | Description |
|---|---|---|---|
Message | string | Yes | Message body text |
To | string | Yes | Recipient phone number (E.164 format, e.g., +11234567890) |
From | string | Yes | Sender phone number (must exist in the tenant’s Twilio sub-account) |
Employee ID | string | Yes | Internal or External ID of the sending employee |
Customer ID | string | Yes | Internal or External ID of the recipient customer |
Store ID | string | Yes | ID of the associated store |
Campaign ID | string | No | Links the dispatch to a campaign |
Expiry Date | string | No | Expiration time in UTC ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). If the message has not been dispatched by this date, it will be marked as Expired. |
Start Date | string | No | Scheduled send time in UTC ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). If in the future, the message is held until this time. |
Important Notes
- All dates must be in UTC ISO 8601 format (
YYYY-MM-DDTHH:mm:ssZ). - Phone numbers must include country code (e.g.,
+12267903132). - Each CSV row creates a separate outreach job.
- Success/failure can be monitored in Admin Console under Outreach Jobs.
- A successfully processed row means the job has been accepted for sending. It does not guarantee delivery.
Outreach SMS CSV Example
See the following Outreach SMS CSV sample file.