This is intended to help conceptualize requests.

We recommend tools such as Postman or ApiDog for development and testing.

Advanced
Parameter Description TypeScript Value
token (Required) Your API Token string
pretty (Optional) true means the response json will include white space for readability. Default is false. boolean
url (Optional) Public, https url to the dataload file. We advise using a signed s3 url when using this path. string
file (Optional) base64 encoded csv file. It should start with "data:text/csv;base64," followed by the encoded csv. 12MB limit. Larger files should use the url parameter. Most secure option. string
adapter (Optional) ID of the adapter to apply to this dataload. string
failureEmails (Optional) Emails to be notified if the dataload does not succeed. array
successEmails (Optional) Emails to be notified when the dataload finishes. array
name (Optional) Optional display name of the file. By default, base64 encoded files will format to api.TIMESTAMP.csv. string