API Reference

Get Bulk Send CSV Template

get
https://www.signwell.com/api/v1/bulk_sends/csv_template

Fetches a CSV template that corresponds to the provided document template IDs. CSV templates are blank CSV files that have columns containing required and optional data that can be sent when creating a bulk send. Fields can be referenced by the field label. Example: [placeholder name]_[field label] could be something like customer_address or signer_company_name (if 'Customer' and 'Signer' were placeholder names for templates set up in SignWell).

Query Params
template_ids[]
array of uuids
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.

template_ids[]*
boolean

When true, returns the CSV as a base64-encoded string in a JSON response instead of a binary file download.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 28 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/octet-stream
application/json

Updated 28 days ago