v1

latestOpenAPI 3.0.12026-07-242682197.7 KB

Bulk Send

Create Bulk Send

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

post/api/v1/bulk_sends

Request body

template_idsstring[] required

Unique identifiers for a list of templates.

bulk_send_csvstring required

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

skip_row_errorsboolean

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

api_application_idstring 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

namestring

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

subjectstring

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

messagestring

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

apply_signing_orderboolean

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

custom_requester_namestring

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_emailstring email

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.

Example request

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

Response

successful

idstring uuid required

template_idsstring[] required

api_application_idstring uuid nullable

documents_countinteger required

created_atstring date-time required

user_idstring uuid nullable

statusstring required