Meet our new brand: eversign is now Xodo Sign! Learn more

Getting Started

Methods

Create Document: Fields

Bulk Sending

Hidden Tags

Embedded Signing

Embedded Requesting

OAuth 2.0

Webhooks

Libraries

Stay up to date

Bulk Sending

Introduction

The intended use for the Bulk Sending feature is sending a large number of documents from templates. Document templates are a well-known component in Xodo Sign. However, sometimes we want to use one template to generate many documents simultaneously (the Bulk of documents).

We have already implemented the Bulk-sending in Xodo Sign UI and documented virtual endpoints in Xodo Sign API.

Bulk Sending Process

The Bulk Sending can be implemented with these steps:

  1. Get Bulk Sending Blank CSV
  2. Validate Bulk Sending CSV
  3. Create Bulk Job

The first step is to call Get Bulk Sending Blank CSV endpoint will generate CSV template from a specific template. This step is vital because different templates might have various CSV structures. Also, if a particular template is updated, the CSV structure probably changes.

Once a user generates a blank CSV template, the next step is to populate this CSV file with data. This data describes Bulk sending documents we want to create from our template.

The next step is to validate if CSV content is correct. For this, we exposed an endpoint to validate Bulk sending CSV. Common validations check if all required fields are present and if data is in the correct format (i.e., email has proper structure).

In the case of failing validation, API will provide a detailed response with validation issues. Once we resolve all validation issues, we can create a Bulk Job.

The endpoint that creates a Bulk Job will trigger the validation process in the background to be extra safe. This way, if integration does not implement the validation step, API will ensure that validation will occur nevertheless.

The final step is to create a Bulk Job with the provided endpoint.

Fetching Bulk Job data/status

Users can perform following actions to check upon the existing Bulk Job(s) data:

Important notes

Bulk sending has the potential to enrich the user experience of your integration significantly.

Before implementing it, you should be aware of these constraints.

Hard limits At the moment, there is a hard limit of 250 created documents per single Bulk Job. In the future, as the feature evolves, these limits will increase.
Validation will always occur Validation is crucial for the Bulk Sending feature. Even if you do not call this endpoint to validate data specifically, the same validation will automatically occur when you create a Bulk Job. Meaning, this validation endpoint is for your convenience to improve user experience in your integration.
Be aware of possible additional costs Be aware of possible additional costs. Bulk Sending feature is generally used to generate lots of documents. These documents are counted against your API quota, which increases the probability that your quota will be used up. When this happens, the system will check if you have overage allowed. If overages are permitted, the Bulk Job will proceed, and you will be additionally charged for additional API documents.