v1

latestOpenAPI 3.1.02026-07-17220542.8 KB

Submissions

Create a submission from DOCX

The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use <code>[[variable_name]]</code> text tags to define dynamic content variables in the document. See <a href="https://www.docuseal.com/examples/demo_template.docx" target="_blank" class="link font-bold">https://www.docuseal.com/examples/demo_template.docx</a> for the specific text variable syntax, including dynamic content tables and lists. You can also use the <code>{{signature}}</code> field syntax to define fillable fields, as in a PDF.<br><b>Related Guides</b><br><a href="https://www.docuseal.com/guides/use-dynamic-content-variables-in-docx-to-create-personalized-documents" class="link">Use dynamic content variables in DOCX to create personalized documents</a>

post/submissions/docx

Request body

namestring

Name of the document submission.

send_emailboolean

Set false to disable signature request emails sending.

send_smsboolean

Set true to send signature request via phone number and SMS.

variablesobject

Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in DOCX.

order'preserved' | 'random'

Pass 'random' to send signature request emails to all parties right away. The order is 'preserved' by default so the second party will receive a signature request email only after the document is signed by the first party.

completed_redirect_urlstring

Specify URL to redirect to after the submission completion.

bcc_completedstring

Specify BCC address to send signed documents to after the completion.

reply_tostring

Specify Reply-To address to use in the notification emails.

expire_atstring

Specify the expiration date and time after which the submission becomes unavailable for signature.

template_idsinteger[]

An optional array of template IDs to use in the submission along with the provided documents. This can be used to create multi-document submissions when some of the required documents exist within templates.

merge_documentsboolean

Set true to merge the documents into a single PDF file.

remove_tagsboolean

Pass false to disable the removal of {{text}} tags from the document. This can be used along with transparent text tags for faster and more robust document processing.

Example request

{
  "name": "Test Submission Document",
  "variables": {
    "variable_name": "value"
  },
  "expire_at": "2024-09-01 12:00:00 UTC",
  "documents": [
    {
      "file": "base64"
    }
  ],
  "submitters": [
    {
      "role": "First Party",
      "email": "john.doe@example.com",
      "phone": "+1234567890",
      "fields": [
        {
          "name": "First Name",
          "validation": {
            "pattern": "[A-Z]{4}"
          },
          "preferences": {
            "font_size": 12,
            "format": "DD/MM/YYYY",
            "price": 99.99
          }
        }
      ]
    }
  ]
}

Response

idinteger required

Submission unique ID number.

namestring

Submission name.

source'invite' | 'bulk' | 'api' | 'embed' | 'link' required

The source of the submission.

submitters_order'random' | 'preserved' required

The order of submitters.

status'completed' | 'declined' | 'expired' | 'pending' required

The status of the submission.

expire_atstring required

Specify the expiration date and time after which the submission becomes unavailable for signature.

created_atstring required

The date and time when the submission was created.

Example response

{
  "expire_at": "2024-09-01 12:00:00 UTC"
}