Create Document

Test API endpoints in real-time

Request

Query Parameters

Response

Click Send to get a response

1. Endpoint Details

Endpoint Details

HTTP Method

POST

Endpoint URL

/api/v1/apiwarehouse/make-document-multi

2. Required Headers

Required Headers

acceptapplication/json

x-api-keyYour API authentication key. Must belong to the same organization as the template.

Content-Typeapplication/json

3. Request Body Schema

Json

{
"name": "Employment Sukrut",
"template_uuid": "686d786cb179e71d01dd9620",
"idom_potent_id" : "34374",
"is_force": false,
"recipients": [
  {
    "email": "john.doe@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "phone_number": "+1234567890",
    "role": "signer",
  }
],
"tokens": [
  {
    "name": "company_name",
    "value": "Acme Corp"
  }
],
"field_recipient_map": {
  "signature_1": "john.doe@example.com"
}
}

4. Request Body Parameters

namestring (required)

Document name/title

template_uuidstring (required)

Valid MongoDB ObjectId of the template to use. Must belong to your organization.

idom_potent_idstring (required)

A unique reference ID generated by your system for each document creation request.

recipientsarray (required)

Array of recipient objects with email, name, role, and styling information

tokensarray (optional)

Custom tokens for template variable replacement. Must match existing variables in your organization.

field_recipient_mapobject (optional)

Mapping of document field names to recipient emails for field assignment

Recipient Object Fields

emailstring (required)

Email address of the recipient

first_namestring (required)

First name of the recipient

last_namestring (required)

Last name of the recipient

phone_numberstring (optional)

Phone number of the recipient

rolestring (optional)

Note: This field is case-sensitive. Both all-lowercase and all-uppercase values are accepted. Example: "signer" and "SIGNER" are valid, but they will be treated as different values.

Important: Each recipient must have a different role, and roles should belong to the template. To create different roles for this document dynamically, use "is_force": true.

5. Example Request

Bash

curl --location 'https://staging.propela-sign.com/api/v1/apiwarehouse/make-document-multi' --header 'accept: application/json' --header 'x-api-key: Swi2LVQeRyxwqtfrdODQzwqclq8LhEsW4_kq74Ti' --header 'Content-Type: application/json' --data-raw '{
"name": "Sukrut DOH 4359",
"idom_potent_id" : "738384",
"is_force" : false,
"template_uuid": "68a6e5b1d21efbe047bf9f18",
"recipients": [
  {
    "email": "riya.dev@thesukrut.com",
    "first_name": "Riya",
    "last_name": "Maheshwari",
    "phone_number": "+1234567890",
    "role": "provider",
    "color": "#FF5733"
  },
      {
    "email": "riya@propela.tech",
    "first_name": "Riya",
    "last_name": "Maheshwari",
    "phone_number": "+1234567890",
    "role": "qa",
    "color": "#FF5733"
  }
],
"tokens": [
{ "name": "Provider Or Assistant Name", "value": "Dr. John Doe" },
{ "name": "Position", "value": "General Physician" },
{ "name": "P NPI Number", "value": "1234567890" },
{ "name": "Provider Or Assistant License", "value": "LIC-987654321" },
{ "name": "Provider Address", "value": "123 Main Street, Suite 400" },
{ "name": "P City", "value": "New York" },
{ "name": "P State", "value": "NY" },
{ "name": "P Zipcode", "value": "10001" },
{ "name": "Provider Name", "value": "Dr. Jane Smith" },
{ "name": "Provider Profession", "value": "Dermatologist" },
{ "name": "Primary Phone", "value": "+1-555-123-4567" },
{ "name": "FirstName", "value": "John" },
{ "name": "LastName", "value": "Doe" },
{ "name": "CIN", "value": "CIN12345678" },
{ "name": "DOB", "value": "1985-05-20" },
{ "name": "Sex", "value": "Male" },
{ "name": "Address", "value": "456 Elm Street" },
{ "name": "City", "value": "San Francisco" },
{ "name": "State", "value": "CA" },
{ "name": "ZipCode", "value": "94107" }
],

"field_recipient_map": {
"Signature" : "riya.dev@thesukrut.com",
"N/A" : "riya.dev@thesukrut.com",
"Value" : "riya@propela.tech",
"Date": "riya@propela.tech",
"Option" : "riya.dev@thesukrut.com"
}
}'

6. Response Fields

successboolean

Indicates if the document creation was successful

idstring

Unique identifier for the created document

namestring

Name of the created document

statusstring

Current status of the document. Always "draft" for newly created documents

organizationstring

Timestamp when the document was created

date_createdstring (ISO date)

Whether the document is disabled (true) or active (false)

date_modifiedstring (ISO date)

Timestamp when the document was last modified

expiration_datestring (ISO date)

Date when the document will expire (3 months from creation)

versionstring/null

Version number of the document (null for initial version)

uuidstring

UUID of the document (same as id)

linksarray

Array of related links for document operations

info_messagestring

Informational message about the document creation and next steps