post
https://production-api.shoutaboutus.com/api/v1/campaign/automate/file-headers
Create the file-header (column-mapping) configuration for an automation campaign and uploads the sample file to S3. The endpoint deletes any existing file-header for the campaign first, and the campaign's type is forced to automation. Sent as multipart/form-data. Emits an audit event (CAMPAIGN_FILE_HEADERS_CREATED).
Auth
- Account bearer. The campaign must belong to the caller's
person.company_id, else404.
Rate limit
- No rate limit.
Body (multipart/form-data)
| Field | Type | Required | Notes |
|---|---|---|---|
rs_campaign_id | integer | Required | Must be an existing campaign and must be owned by caller and not bulk_upload/kiosk. |
file_headers | string (JSON) | Required | JSON object; must contain non-empty string values for email, phone, customer_name, location_identifier. |
sample_file | file | Required | mimes:xlsx,xls,csv, max 10 MB (10240 KB). |
location_identifier | string | Required | Max 255. Unique per campaign store-group. |
Behaviour
201with the createdCampaignAutomationFileHeaderrow underdata.data.400if the campaign is a bulk_upload/kiosk type, orfile_headersis missing required keys / has non-string values.404if the campaign is not found or not owned by the caller.422if base validation fails (missing file, wrong mime, duplicatelocation_identifier, etc.).
Saves
data.data.idintofileHeaderIdfor the update/delete/sample-file requests.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…