v1

latestOpenAPI 3.1.02026-07-14220425.8 KB

Submissions

Create submissions from emails

This API endpoint allows you to create submissions for a document template and send them to the specified email addresses. This is a simplified version of the POST /submissions API to be used with Zapier or other automation tools.

post/submissions/emails

Request body

template_idinteger required

The unique identifier of the template.

emailsstring required

A comma-separated list of email addresses to send the submission to.

send_emailboolean

Set false to disable signature request emails sending.

Example request

{
  "template_id": 1000001,
  "emails": "{{emails}}"
}

Response

idinteger required

Submitter unique ID number.

submission_idinteger required

Submission unique ID number.

uuidstring required

Submitter UUID.

emailstring nullable required

The email address of the submitter.

slugstring required

Unique key to be used in the form signing link and embedded form.

status'completed' | 'declined' | 'opened' | 'sent' | 'awaiting' required

The status of signing request for the submitter.

metadataobject required

Metadata object with additional submitter information.

sent_atstring nullable required

The date and time when the signing request was sent to the submitter.

opened_atstring nullable required

The date and time when the submitter opened the signing form.

completed_atstring nullable required

The date and time when the submitter completed the signing form.

declined_atstring nullable required

The date and time when the submitter declined the signing form.

created_atstring required

The date and time when the submitter was created.

updated_atstring required

The date and time when the submitter was last updated.

namestring nullable required

The name of the submitter.

phonestring nullable required

The phone number of the submitter.

external_idstring nullable required

Your application-specific unique string key to identify this submitter within your app.

rolestring required

The role of the submitter in the signing process.

embed_srcstring required

The src URL value to embed the signing form or sign via a link.