API Reference

Create Bulk Send

post
https://www.signwell.com/api/v1/bulk_sends

Creates a bulk send, and it validates the CSV file before creating the bulk send.

Body Params
template_ids
array of uuids
required

Unique identifiers for a list of templates.

template_ids*
string
required

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

boolean
Defaults to false

Whether to skip errors in the rows. Defaults to false.

uuid

Unique identifier for API Application settings to use. API Applications are optional and mainly used when isolating OAuth apps or for more control over embedded API settings

string

The name of the Bulk Send. Will be used as the document name for each of the documents.

string

Email subject for the signature request that recipients will see. Defaults to the default system subject or a template subject.

string

Email message for the signature request that recipients will see. Defaults to the default system message or a template message.

boolean
Defaults to false

When set to true recipients will sign one at a time in the order of the recipients collection of this request.

string

Sets the custom requester name for the document. When set, this is the name used for all email communications, signing notifications, and in the audit file.

string

Sets the custom requester email for the document. When set, this is the email used for all email communications, signing notifications, and in the audit file.

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/json

Updated 28 days ago