v1

latestOpenAPI 3.0.12026-07-242682197.7 KB

Bulk Send

Validate Bulk Send CSV

Validates a Bulk Send CSV file before creating the Bulk Send. It will check the structure of the CSV and the data it contains, and return any errors found.

post/api/v1/bulk_sends/validate_csv

Request body

template_idsstring[] required

Specify one or more templates to generate a single blank CSV file that will contain available columns for your recipient data. The template_ids[] parameter is an array of template IDs (e.g.,/?template_ids[]=5a67dbd7-928a-4ea0-a7e2-e476a0eb045f&template_ids[]=d7315111-c671-4b15-8354-c9a19bbaefa0). Each ID should be a separate parameter in the query string.

bulk_send_csvstring required

A RFC 4648 base64 string of the template CSV file to be validated.

Example request

{
  "template_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "bulk_send_csv": "bmFtZSxlbWFpbApUZXN0LHRlc3RAZXhhbXBsZS5jb20K"
}

Response

successful

bulk_send_csvstring required

Base64-encoded CSV content

template_idsstring[] required

skip_row_errorsboolean

api_application_idstring uuid nullable

namestring

subjectstring

messagestring

apply_signing_orderboolean