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. A template that carries a pre-applied signature or initials field cannot be used while 21 CFR Part 11 is enabled, which requires every signature to be signed by the recipient: it returns a 422.

template_ids*

bulk_send_csv

string

required

A RFC 4648 base64 string of the template CSV file to be validated. While 21 CFR Part 11 is enabled, every recipient needs a name: the CSV must carry a name column next to each placeholder email column (for example signer_name alongside signer_email), and each row must fill that name in wherever it carries the matching email, otherwise it returns a 422. A row that leaves both the email and the name blank sends nothing to that placeholder, so no name is needed there.

skip_row_errors

boolean

Defaults to false

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

api_application_id

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

name

string

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

subject

string

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

message

string

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

apply_signing_order

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.

custom_requester_name

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.

custom_requester_email

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

201successful

401unauthorized

422unprocessable entity

429rate limit exceeded