---
title: "Bulk invite"
method: POST
path: "/template/{document_id}/bulkinvite"
---

# Bulk invite

`POST /template/{document_id}/bulkinvite`

## Request

- Base URL: `https://api.signnow.com`
- URL: `https://api.signnow.com/template/{document_id}/bulkinvite`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/signnow/apis/signnow-api/docs/template/:document_id/bulkinvite/post.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint allows API users to create multiple invites to different signers from one template. A new document is generated for each signer and stored in the needed folder.

To create a bulk invite, you need a CSV file with signers' roles, emails, and document names. The format is the following:

**For one role**

```json

Recipient 1|signer1@email.com,document_name
Recipient 1|signer2@email.com,document_name

```

**For multiple roles**

```json

Recipient 1|signer1@email.com,Recipient 2|signer2@email.com,document_name1
Recipient 1|signer3@email.com,Recipient 2|signer4@email.com,document_name2

```

All the roles in the CSV must be assigned to at least one field in the template, and all the roles that exist in the template must be in the CSV.

## Request body `multipart/form-data`

- object
  - `file` unknown, required
  - `folder_id` string, required: ID of the folder to store the documents in. To find the ID, use [`GET /user/folder`](/docs/folder/operations/get-all-folders).
  - `subject` string: Custom email subject for all signers
  - `email_message` string: Custom email message for all signers
  - `client_timestamp` integer: The timestamp in UNIX code
  - `signature_type` string: Type of QES signature requested from signers. Possible values: `eideasy`, `eideasy-pdf`, `nom151`. Available to members of an organization with QES settings enabled. For more information, see the [QES user guide](/docs/qualified-electronic-signature).

## Response `200`

The bulk invite was queued. Documents are created and invites are sent in the background.

- object
  - `status` string: Status of the bulk invite job. Always `job queued`.

## Other responses

- `400`: * Incorrect file type (must be a CSV). * Missing CSV file. * Missing `folder_id`. * Missing or extra recipients in the CSV file. * Document name in the CSV file is missing or incorrect. * QES is not set for this user's organization. * User cannot use QES if not in organization. * Incorrect `signature_type`. Allowed values: `eideasy`,`eideasy-pdf`, `nom151`.

---

[API](https://skmtc.dev/signnow/apis/signnow-api.md) - [All operations](https://skmtc.dev/signnow/apis/signnow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/signnow/apis/signnow-api/revisions/1c9c30a6142b?raw)