eSignatures.com

https://esignatures.com/docs/api
Admin
eSignatures.com is an electronic signature platform providing a REST API that enables users to...
Tokens:20,753
Snippets:165
Trust Score:8.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### Query Contract Details Example

Source: https://esignatures.com/docs/api

Example cURL request and the corresponding JSON response structure for a contract query.

```bash
curl -X GET 'https://esignatures.com/api/contracts/1contr11-2222' -u 'your-secret-token:'
```

```json
{
  "data": {
    "contract":{
      "id": "1contr11-2222",
      "status": "sent",
      "title": "Rental Agreement",
      "metadata": "ID0001",
      "source": "api",
      "test": "no",
      "contract_pdf_url": "https://aws.com/contracts/1contr11-2222?authx=x123y",
      "labels": ["MA", "Rental"],
      "signers": [
        {
          "id": "6signer6-9999",
          "name": "Sam Signer",
          "email": "sam@tenants.com",
          "mobile": "+12481234567",
          "company_name": "ACME Corp",
          "sign_page_url": "https://esignatures.com/sign/6signer6-9999",
          "signer_field_values": {
            "city": "Boston",
            "preferred_contact": "Phone"
          }
        }
      ]
    }
  }
}
```

--------------------------------

### Example Iframe Code

Source: https://esignatures.com/docs/api#esignatures-api

A concrete example of an iframe tag with a specific URL.

```html
<iframe src="https://esignatures.com/sign/11111111-222222-333333?embedded=yes"></iframe>
```

--------------------------------

### cURL Request Example

Source: https://esignatures.com/docs/api

Example of using cURL to send a POST request with JSON payload for template content updates.

```bash
curl -X POST -H 'Content-type:application/json' 'https://esignatures.com/api/templates/4templ44-6666/content' -d '{"edits":[{"find_markdown":" including weekends.","replace_with_markdown":" excluding weekends"}]}' -u 'your-secret-token:'
```

--------------------------------

### Add Signer Request Example

Source: https://esignatures.com/docs/api

Example cURL request to add a signer using a secret token for authentication.

```bash
curl -X POST -H 'Content-type:application/json' 'https://esignatures.com/api/contracts/1contr11-2222/signers' -d '{"name":"Sam Signer-Smith","email":"sam@tenants.com"}' -u 'your-secret-token:'
```

--------------------------------

### JSON Response Example

Source: https://esignatures.com/docs/api

The expected JSON response indicating a successful update.

```json
{
  "status": "updated",
  "data": {
    "markdown": "# Updated contract content here...\nNew terms..."
  }
}
```

--------------------------------

### Signer Response Example

Source: https://esignatures.com/docs/api

The expected JSON response upon successfully queuing a signer addition.

```json
{
  "status": "queued"
}
```

--------------------------------

### cURL Example Request

Source: https://esignatures.com/docs/api

A sample cURL command to create a contract using a template and specific signer details.

```bash
curl -X POST -H 'Content-type:application/json' 'https://esignatures.com/api/contracts' -d '{"template_id": "4templ44-6666","signers":[{"name":"Sam Signer","email":"sam@tenants.com","mobile":"+12481234567"}],"placeholder_fields":[{"placeholder_key":"preferred_term","replace_with_text":"24 months"}], "test": "yes"}' -u 'your-secret-token:'
```

--------------------------------

### Markdown and Extended JSON Syntax Example

Source: https://esignatures.com/docs/api

Demonstrates the integration of standard Markdown with JSON-based configuration for signer inputs and document formatting.

```markdown
# Rental Agreement

This agreement is between the rental provider/s and the renter/s.

- The renter agrees to pay rent on the 1st of each month.
- The rental provider agrees to maintain the property in good condition.

## Special conditions `{"header_counter": "yes"}`

I agree to the above **terms and conditions**. `{"alignment": "center"}`

Parent name `{"line_type": "text-input", "input_type": "only_first_signer", "input_required": "yes", "signer_field_id": "parent-name"}`

Preferred device `{"line_type": "select-input", "input_type": "only_first_signer", "select_values": "Desktop\nTablet\nMobile"}`

I accept the privacy policy `{"line_type": "checkbox", "input_type": "every_signer", "input_required": "yes"}`

| Header 1 | Header 2 |
| -------- | -------- |
| cell 1   | cell 2   |
```

--------------------------------

### Update Signer cURL Example

Source: https://esignatures.com/docs/api

Example request using cURL to update signer information.

```bash
curl -X POST -H 'Content-type:application/json' 'https://esignatures.com/api/contracts/1contr11-2222/signers/6signer6-9999' -d '{"email":"sam@tenants.com", "name":"Sam Signer-Smith"}' -u 'your-secret-token:'
```

--------------------------------

### GET /api/templates

Source: https://esignatures.com/docs/api

Retrieves a list of all available templates.

```APIDOC
## GET /api/templates

### Description
Returns a list of available templates.

### Method
GET

### Endpoint
/api/templates

### Response
#### Success Response (200)
- **data** (array) - List of templates.
- **template_id** (string) - The unique ID of the template.
- **title** (string) - The title of the template.

#### Response Example
{
  "data": [
    {
      "template_id": "4templ44-6666",
      "title": "Rental Agreement"
    }
  ]
}
```

--------------------------------

### Create Contract via POST Request

Source: https://esignatures.com/docs/api

Example cURL command to create a new contract via the API.

```bash
curl -X POST -H 'Content-type:application/json' 'https://esignatures.com/api/contracts' -d '{"template_id": "4templ44-6666","signers":[{"name":"Sam Signer","email":"sam@tenants.com"}]}' -u 'your-secret-token:'
```

--------------------------------

### Query Contract Request

Source: https://esignatures.com/docs/api#esignatures-api

Example cURL request to fetch contract details using a secret token for authentication.

```bash
curl -X GET 'https://esignatures.com/api/contracts/1contr11-2222' -u 'your-secret-token:'
```

--------------------------------

### Duplicate Template Request

Source: https://esignatures.com/docs/api

Example cURL request to duplicate a template with placeholder field replacements.

```bash
curl -X POST -H 'Content-type:application/json' 'https://esignatures.com/api/templates/<template-id>/duplicate' -d '{"title":"Rental Agreement","placeholder_fields":[{"placeholder_key":"business_name","replace_with_text":"ACME Co"}]}' -u 'your-secret-token:'
```

--------------------------------

### Query Contract Details Request

Source: https://esignatures.com/docs/api

The HTTP GET request structure for retrieving contract details by ID.

```http
GET /api/contracts/<contract_id> HTTP/1.1

```

--------------------------------

### GET /api/templates/<template_id>/content

Source: https://esignatures.com/docs/api

Retrieves the markdown content of a specific template.

```APIDOC
## GET /api/templates/<template_id>/content

### Description
Returns the content of the template in markdown format.

### Method
GET

### Endpoint
/api/templates/<template_id>/content

### Parameters
#### Path Parameters
- **template_id** (string) - Required - The unique ID of the template.

### Response
#### Success Response (200)
- **template_id** (string) - The unique ID of the template.
- **markdown** (string) - Content of the template in markdown format.

#### Response Example
{
  "data": {
    "template_id": "4templ44-6666",
    "markdown": "# Terms\n\nThis document sets out the agreement between..."
  }
}
```

--------------------------------

### GET /api/templates/<template_id>

Source: https://esignatures.com/docs/api

Retrieves the details of a specific template, including placeholder fields and signer fields.

```APIDOC
## GET /api/templates/<template_id>

### Description
Returns the details of a specific template, including the Placeholder fields and signer fields.

### Method
GET

### Endpoint
/api/templates/<template_id>

### Parameters
#### Path Parameters
- **template_id** (string) - Required - The unique ID of the template.

### Response
#### Success Response (200)
- **template_id** (string) - The unique ID of the template.
- **title** (string) - The title of the template.
- **created_at** (string) - The date and time the template was created.
- **placeholder_fields** (array) - List of Placeholder fields in the template.
- **signer_field_ids** (array) - List of the Signer field ID-s assigned to Signer fields in the template.

### Response Example
{
  "data": {
    "template_id": "4templ44-6666",
    "title": "Rental Agreement",
    "created_at": "2015-10-24T15:15:35.979",
    "placeholder_fields": ["interest_rate"],
    "signer_field_ids": ["preferred_term"]
  }
}
```

--------------------------------

### GET /api/templates/<template_id>/collaborators

Source: https://esignatures.com/docs/api

Retrieves a list of collaborators associated with a specific template.

```APIDOC
## GET /api/templates/<template_id>/collaborators

### Description
Returns the list of collaborators for the specified template.

### Method
GET

### Endpoint
/api/templates/<template_id>/collaborators

### Parameters
#### Path Parameters
- **template_id** (string) - Required - The ID of the template.

### Response
#### Success Response (200)
- **data** (array) - List of collaborator objects
- **template_collaborator_id** (string) - The ID of the collaborator
- **template_id** (string) - The ID of the template
- **name** (string) - The name of the collaborator
- **email** (string) - The email address of the collaborator
- **template_collaborator_editor_url** (string) - URL to access the template editor

#### Response Example
{
  "data": [
    {
      "template_collaborator_id": "5templcoll5-7777",
      "template_id": "4templ44-6666",
      "name": "Chris Colleague",
      "email": "chris@acme.com",
      "template_collaborator_editor_url": "https://esignatures.com/contract_template_collaborators/5templcoll5-7777/editor"
    }
  ]
}
```

--------------------------------

### GET /api/contracts/<contract_id>/content

Source: https://esignatures.com/docs/api

Retrieves the current content of a specific contract in markdown format.

```APIDOC
## GET /api/contracts/<contract_id>/content

### Description
Returns the content of the contract.

### Method
GET

### Endpoint
/api/contracts/<contract_id>/content

### Parameters
#### Path Parameters
- **contract_id** (string) - Required - The unique ID of the contract.

### Response
#### Success Response (200)
- **contract_id** (string) - The unique ID of the contract.
- **markdown** (string) - Content of the contract in markdown format.

### Response Example
{
  "data": {
    "contract_id": "1contr11-2222",
    "markdown": "# Terms\n\nThis document sets out the agreement between..."
  }
}
```

--------------------------------

### GET /api/contracts/<contract_id>/placeholder_fields

Source: https://esignatures.com/docs/api

Retrieves the current placeholder field values assigned to a specific contract.

```APIDOC
## GET /api/contracts/<contract_id>/placeholder_fields

### Description
Returns the Placeholder field values currently assigned to the contract.

### Method
GET

### Endpoint
/api/contracts/<contract_id>/placeholder_fields

### Parameters
#### Path Parameters
- **contract_id** (string) - Required - The unique identifier of the contract.

### Response
#### Success Response (200)
- **data** (array) - List of placeholder field objects.
- **placeholder_key** (string) - The placeholder key (without curly braces).
- **replace_with_text** (string) - Plain text used to replace the Placeholder field.
- **replace_with_markdown** (string) - Markdown content used to replace the Placeholder field.
- **replace_with_template** (string) - Returns '[template content]' when a template is specified.

### Response Example
{
  "data": [
    {
      "placeholder_key": "package_name",
      "replace_with_text": "Saver"
    }
  ]
}
```

--------------------------------

### Create New Template

Source: https://esignatures.com/docs/api

Creates a new template using a title, markdown content, and optional labels.

```http
POST /api/templates HTTP/1.1
```

```bash
curl -X POST -H 'Content-type:application/json' 'https://esignatures.com/api/templates' -d '{"title":"Rental Agreement","markdown":"## Terms\n\nThis document sets out the agreement between..."}' -u 'your-secret-token:'
```

```json
{
  "title": "Rental Agreement",
  "labels": ["Generic Agreement", "Acme Client Corp"],
  "markdown": "# Terms\n\nThis document sets out the agreement between..."
}
```

```json
{
  "data": [
    {
      "template_id": "4templ44-6666"
    }
  ]
}
```

--------------------------------

### Embed Signing Page with Auto-Resize

Source: https://esignatures.com/docs/api

Iframe implementation using iframe-resizer for dynamic height adjustment.

```html
<script src="https://code.jquery.com/jquery-3.4.1.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/iframe-resizer@4.2.10/js/iframeResizer.min.js"></script>
<iframe
    src="SIGN_PAGE_URL?embedded=yes"
    id="eSignaturesIframe"
    onload="iFrameResize({heightCalculationMethod: 'bodyScroll'}, '#eSignaturesIframe')"
    style="min-width: 100%; border: none;">
</iframe>
```

--------------------------------

### POST /api/templates

Source: https://esignatures.com/docs/api

Creates a new template.

```APIDOC
## POST /api/templates

### Description
Creates a new template.

### Method
POST

### Endpoint
/api/templates

### Parameters
#### Request Body
- **title** (string) - Required - The title of the new template.
- **markdown** (string) - Required - Defines the content of the new template.
- **labels** (array) - Optional - Optional labels assigned to the template and its contracts.

### Response
#### Success Response (200)
- **data** (array) - A list containing the created template details.
  - **template_id** (string) - The unique identifier of the created template.
```

--------------------------------

### List Templates

Source: https://esignatures.com/docs/api

Retrieves a list of all available templates.

```http
GET /api/templates HTTP/1.1
```

```bash
curl -X GET 'https://esignatures.com/api/templates' -u 'your-secret-token:'
```

```json
{
  "data": [
    {
      "template_id": "4templ44-6666",
      "title": "Rental Agreement"
    }
  ]
}
```

--------------------------------

### Authentication and API Basics

Source: https://esignatures.com/docs/api

Details on how to authenticate requests using your Secret Token and general usage guidelines for the REST API.

```APIDOC
## Authentication

### Description
Authentication is handled via HTTP Basic Auth. Use your Secret Token as the username, with no password required.

### Parameters
- **Basic Auth** (string) - Required - Secret Token as username, empty password
- **token** (string) - Optional - Your API secret token passed as a URL parameter (e.g., ?token=your-secret-token)

### Request Example
curl -X POST 'https://esignatures.com/api/:action' -u 'your-secret-token:''
```

--------------------------------

### Authenticate with API using cURL

Source: https://esignatures.com/docs/api

Use HTTP Basic Auth with your Secret Token as the username and an empty password.

```bash
curl -X POST 'https://esignatures.com/api/:action' -u 'your-secret-token:''
```

--------------------------------

### POST /api/contracts

Source: https://esignatures.com/docs/api

Creates a new contract. Use this to initiate the signing process and retrieve the sign_page_url for embedding.

```APIDOC
## POST /api/contracts

### Description
Creates a new contract. To embed the signing page, include `signature_request_delivery_methods=[]` to prevent automatic delivery of the signature request.

### Method
POST

### Endpoint
https://esignatures.com/api/contracts

### Request Body
- **template_id** (string) - Required - The ID of the template to use.
- **signers** (array) - Required - List of signers including name and email.
- **signature_request_delivery_methods** (array) - Optional - Set to [] to disable automatic email/SMS delivery.
- **multi_factor_authentications** (array) - Optional - Authentication methods like ['sms_verification_code'].
- **redirect_url** (string) - Optional - URL to redirect the signer to after signing.

### Request Example
{
  "template_id": "4templ44-6666",
  "signers": [{"name": "Sam Signer", "email": "sam@tenants.com"}]
}
```

--------------------------------

### Generate PDF preview

Source: https://esignatures.com/docs/api

Triggers an asynchronous PDF generation process. A webhook notification is sent once the file is ready.

```http
POST /api/contracts/<contract_id>/generate_pdf_preview HTTP/1.1
```

```bash
curl -X POST 'https://esignatures.com/api/contracts/1contr11-2222/generate_pdf_preview' -u 'your-secret-token:'
```

```json
{
  "status": "queued"
}
```

--------------------------------

### GET /api/contracts/<contract_id>

Source: https://esignatures.com/docs/api

Retrieves the details of a specific contract by its unique ID, including status, metadata, and signer information.

```APIDOC
## GET /api/contracts/<contract_id>

### Description
Returns the contract details, including information about the signers and any values entered by the signers.

### Method
GET

### Endpoint
/api/contracts/<contract_id>

### Parameters
#### Path Parameters
- **contract_id** (string) - Required - The unique ID for the contract.

### Response
#### Success Response (200)
- **id** (string) - The unique ID for the contract.
- **status** (string) - Status of the contract: draft, sent, signed or withdrawn.
- **title** (string) - The unique title of the contract.
- **metadata** (string) - Custom metadata attached to the contract request.
- **source** (string) - The origin of the contract, e.g., api, ui or zapier.
- **test** (string) - Whether the contract is a test (yes).
- **contract_pdf_url** (string) - When the contract is signed, the finalized PDF can be accessed via this url.
- **labels** (array) - The Assigned list of labels.
- **signers** (array) - List of signers.

#### Response Example
{
  "data": {
    "contract": {
      "id": "1contr11-2222",
      "status": "sent",
      "title": "Rental Agreement",
      "metadata": "ID0001",
      "source": "api",
      "test": "no",
      "contract_pdf_url": "https://aws.com/contracts/1contr11-2222?authx=x123y",
      "labels": ["MA", "Rental"],
      "signers": [
        {
          "id": "6signer6-9999",
          "name": "Sam Signer",
          "email": "sam@tenants.com",
          "mobile": "+12481234567",
          "company_name": "ACME Corp",
          "sign_page_url": "https://esignatures.com/sign/6signer6-9999",
          "signer_field_values": {
            "city": "Boston",
            "preferred_contact": "Phone"
          }
        }
      ]
    }
  }
}
```

--------------------------------

### HTTP Request Method

Source: https://esignatures.com/docs/api

The endpoint uses the POST method to initiate contract creation.

```http
POST /api/contracts HTTP/1.1
```

--------------------------------

### POST /api/contracts/<contract_id>/generate_pdf_preview

Source: https://esignatures.com/docs/api

Generates a PDF preview of the contract and triggers a webhook notification when ready.

```APIDOC
## POST /api/contracts/<contract_id>/generate_pdf_preview

### Description
Generates a PDF preview of the contract and sends a `contract-pdf-generated` Webhook notification with a direct URL to the PDF once it's ready.

### Method
POST

### Endpoint
/api/contracts/<contract_id>/generate_pdf_preview

### Parameters
#### Path Parameters
- **contract_id** (string) - Required - The unique identifier of the contract.

### Request Example
curl -X POST 'https://esignatures.com/api/contracts/1contr11-2222/generate_pdf_preview' -u 'your-secret-token:'

### Response
#### Success Response (200)
- **status** (string) - The status of the request, returns 'queued'.

#### Response Example
{
  "status": "queued"
}
```

--------------------------------

### JSON Request Parameters

Source: https://esignatures.com/docs/api

The full JSON structure for creating a contract, including signers, placeholder fields, and email customization.

```json
{
  "template_id": "4templ44-6666",
  "title": "Loan Agreement - Saver package",
  "locale": "en",
  "metadata": "ID0001",
  "expires_in_hours": "48",
  "custom_webhook_url": "https://your-website.com/esignatures-custom-webhook",
  "assigned_user_email": "colleague@your-business.com",
  "labels": ["MA", "Rental"],
  "test": "no",
  "save_as_draft": "no",
  "signers": [
    {
      "name": "Benny Bell",
      "email": "benny@me.com",
      "mobile": "+12481234567",
      "company_name": "ACME Corp",
      "signing_order": "1",
      "auto_sign": "no",
      "signature_request_delivery_methods": ["email"],
      "signed_document_delivery_method": "email",
      "multi_factor_authentications": ["sms_verification_code"],
      "redirect_url": "https://your-website.com/aftersign"
    }
  ],
  "placeholder_fields": [
    {
      "placeholder_key": "package_name",
      "replace_with_text": "Saver"
    },
    {
      "placeholder_key": "repayment_terms",
      "replace_with_markdown": "## Repayment terms\n\n- Payments due: monthly\n- Term: 15 years"
    },
    {
      "placeholder_key": "additional_conditions",
      "replace_with_template": "5templ55-7777"
    }
  ],
  "signer_fields": [
    {
      "signer_field_id": "preferred_term",
      "default_value": "15 years"
    }
  ],
  "emails": {
    "signature_request_subject": "Your document is ready to sign",
    "signature_request_text": "Hi __FULL_NAME__, \n\n To review and sign the contract please press the button below \n\n Kind Regards",
    "final_contract_subject": "Your document is signed",
    "final_contract_text": "Hi __FULL_NAME__, \n\n Your document is signed.\n\nKind Regards",
    "cc_email_addresses": ["tom@email.com", "francis@email.com"],
    "reply_to": "support@customdomain.com"
  },
  "custom_branding": {
    "company_name": "WhiteLabel LLC",
    "logo_url": "https://online-logo-store.com/yourclient-logo.png"
  }
}
```

--------------------------------

### POST /api/contracts

Source: https://esignatures.com/docs/api

Creates a new contract and sends it to signers via communication channels to collect signatures.

```APIDOC
## POST /api/contracts

### Description
This request generates a contract and, by default, sends it to the signers via the chosen communication channels to collect their signatures.

### Method
POST

### Endpoint
/api/contracts

### Parameters
#### Request Body
- **template_id** (string) - Required - Specifies which template to use for the contract.
- **title** (string) - Optional - Unique title for the contract.
- **locale** (string) - Optional - Language setting for the signer page and emails.
- **metadata** (string) - Optional - Custom data attached to the contract.
- **expires_in_hours** (string) - Optional - Expiry time in hours.
- **custom_webhook_url** (string) - Optional - Custom URL for webhook notifications.
- **assigned_user_email** (string) - Optional - Assigns a user to manage the contract.
- **labels** (array) - Optional - List of labels for the contract.
- **test** (string) - Optional - Marks the contract as a demo.
- **save_as_draft** (string) - Optional - Saves as draft instead of sending.
- **signers** (array) - Required - List of individuals required to sign.

### Request Example
{
  "template_id": "4templ44-6666",
  "signers": [
    {
      "name": "Benny Bell",
      "email": "benny@me.com",
      "mobile": "+12481234567"
    }
  ]
}

### Response
#### Success Response (200)
- **status** (string) - The status of the request.
- **data** (object) - The contract details.

#### Response Example
{
  "status": "queued",
  "data": {
    "contract": {
      "id": "1contr11-2222",
      "status": "sent"
    }
  }
}
```

--------------------------------

### Signer viewed the contract

Source: https://esignatures.com/docs/api

This webhook is triggered when a signer views the contract for the first time.

```APIDOC
## Signer viewed the contract

### Description
This webhook is triggered when a signer views the contract for the first time.

### Response Example
{
  "status": "signer-viewed-the-contract",
  "data": {
    "signer": {
      "id": "6signer6-9999",
      "name": "Sam Signer",
      "email": "sam@tenants.com",
      "mobile": "+12481234567",
      "company_name": "ACME Corp",
      "signing_order": "1",
      "auto_sign": "no",
      "redirect_url": ""
    },
    "contract": {
      "id": "mobile1contr11-2222",
      "title": "Sample NDA",
      "metadata": "ID0001",
      "source": "api",
      "test": "no"
    }
  }
}
```

--------------------------------

### Query Template Details

Source: https://esignatures.com/docs/api

Retrieves information for a specific template by ID. Requires authentication via a secret token.

```http
GET /api/templates/<template_id> HTTP/1.1
```

```bash
curl -X GET 'https://esignatures.com/api/templates/4templ44-6666' -u 'your-secret-token:'
```

```json
{
  "data": {
    "template_id": "4templ44-6666",
    "title": "Rental Agreement",
    "created_at": "2015-10-24T15:15:35.979",
    "placeholder_fields": ["interest_rate"],
    "signer_field_ids": ["preferred_term"]
  }
}
```

--------------------------------

### POST /api/:action

Source: https://esignatures.com/docs/api#esignatures-api

General endpoint for performing actions within the eSignatures.com API.

```APIDOC
## POST /api/:action

### Description
Executes a specific action within the eSignatures.com platform. Authentication is required via HTTP Basic Auth using a Secret Token.

### Method
POST

### Endpoint
https://esignatures.com/api/:action

### Parameters
#### Path Parameters
- **action** (string) - Required - The specific API action to perform.

#### Query Parameters
- **token** (string) - Optional - Alternative to Basic Auth, your API secret token.

### Request Example
curl -X POST 'https://esignatures.com/api/:action' -u 'your-secret-token:''
```

--------------------------------

### Embed Signing Page via Iframe

Source: https://esignatures.com/docs/api

Basic iframe implementation for embedding the signing page.

```html
<iframe src="SIGN_PAGE_URL?embedded=yes">
</iframe>
```

```html
<iframe src="https://esignatures.com/sign/11111111-222222-333333?embedded=yes"></iframe>
```

--------------------------------

### JSON Request Parameters

Source: https://esignatures.com/docs/api

Detailed JSON structure for customizing template content during duplication.

```json
{
  "title": "Rental Agreement",
  "placeholder_fields": [
    {
      "placeholder_key": "business_name",
      "replace_with_text": "ACME Co"
    },
    {
      "placeholder_key": "special_conditions",
      "replace_with_markdown": "# Special conditions\n\nInformation related, but not limited to the development projects and assignments."
    },
    {
      "placeholder_key": "additional_conditions",
      "replace_with_template": "5templ55-7777"
    }
  ],
  "target_secret_token": "another-accounts-secret-token"
}
```

--------------------------------

### Send a draft contract

Source: https://esignatures.com/docs/api

Transitions a contract from draft status to active for signature collection. Only applicable to contracts currently in draft status.

```http
POST /api/contracts/<contract_id>/send_draft HTTP/1.1
```

```bash
curl -X POST 'https://esignatures.com/api/contracts/1contr11-2222/send_draft' -u 'your-secret-token:'
```

```json
{
  "status": "queued"
}
```

--------------------------------

### Query Placeholder Fields

Source: https://esignatures.com/docs/api

Retrieve the current placeholder field values assigned to a specific contract.

```http
GET /api/contracts/<contract_id>/placeholder_fields HTTP/1.1
```

```bash
curl -X GET 'https://esignatures.com/api/contracts/1contr11-2222/placeholder_fields' -u 'your-secret-token:'
```

```json
{
  "data": [
    {
      "placeholder_key": "package_name",
      "replace_with_text": "Saver"
    },
    {
      "placeholder_key": "repayment_terms",
      "replace_with_markdown": "## Repayment terms\n\n- Payments due: monthly\n- Term: 15 years"
    },
    {
      "placeholder_key": "additional_conditions",
      "replace_with_template": "[template content]"
    }
  ]
}
```

--------------------------------

### Query Template Content

Source: https://esignatures.com/docs/api

Retrieves the markdown content of a template by its ID.

```http
GET /api/templates/<template_id>/content HTTP/1.1
```

```bash
curl -X GET 'https://esignatures.com/api/templates/4templ44-6666/content' -u 'your-secret-token:'
```

```json
{
  "data": {
    "template_id": "4templ44-6666",
    "markdown": "# Terms\n\nThis document sets out the agreement between..."
  }
}
```

--------------------------------

### Signer Request Parameters

Source: https://esignatures.com/docs/api

JSON structure for the request body when adding a signer.

```json
{
  "name": "Sam Signer",
  "email": "sam@tenants.com",
  "mobile": "+1 541 754 3010",
  "company_name": "ACME Corp",
  "signing_order": "1",
  "auto_sign": "no",
  "signature_request_delivery_methods": ["email"],
  "signed_document_delivery_method": "email",
  "multi_factor_authentications": ["sms_verification_code"],
  "redirect_url": "https://your-website.com/aftersign"
}
```

--------------------------------

### Update Template

Source: https://esignatures.com/docs/api

Updates template metadata such as title and labels. Requires a POST request with JSON parameters.

```http
POST /api/templates/<template_id> HTTP/1.1
```

```bash
curl -X POST -H 'Content-type:application/json' 'https://esignatures.com/api/templates/4templ44-6666' -d '{"title":"Rental Agreement"}' -u 'your-secret-token:'
```

```json
{
  "title": "Rental Agreement",
  "labels": ["Generic templates", "Acme Client Corp"]
}
```

```json
{
  "status": "queued"
}
```

--------------------------------

### Contract signed

Source: https://esignatures.com/docs/api

This webhook is triggered once all signers have signed the contract. It includes a link to download the signed PDF.

```APIDOC
## Webhook: contract-signed

### Description
This webhook is triggered once all signers have signed the contract. It includes a link to download the signed PDF.

### Fields
- **status** - 'contract-signed'
- **id** - ID of the contract.
- **title** - The unique title of the contract.
- **metadata** - Metadata included in the original request.
- **source** - Source of the contract: `api`, `ui` or `zapier`
- **test** - Indicates whether it's a test contract (`yes`).
- **contract_pdf_url** - URL to access the signed PDF (expires after 3 days).
- **signers** - List of signers added to the contract.

### Request Example
{
  "status": "contract-signed",
  "data": {
    "contract": {
      "id": "1contr11-2222",
      "title": "Sample NDA",
      "metadata": "ID0001",
      "source": "api",
      "test": "no",
      "contract_pdf_url": "https://aws.com/contracts/1contr11-2222?secret_token=x123y",
      "signers": [
        {
          "id": "6signer6-9999",
          "name": "Sam Signer",
          "email": "sam@tenants.com",
          "mobile": "+12481234567",
          "company_name": "ACME Corp",
          "signer_field_values": {
            "city": "Boston",
            "preferred_contact": "Phone"
          }
        }
      ]
    }
  }
}
```

--------------------------------

### JSON Response

Source: https://esignatures.com/docs/api

The expected JSON response containing the new template ID.

```json
{
  "data": [
    {
      "template_id": "4templ44-6666"
    }
  ]
}
```

--------------------------------

### JSON Response

Source: https://esignatures.com/docs/api

The response returned upon successful contract creation, containing the contract ID and status.

```json
{
  "status": "queued",
  "data": {
    "contract": {
      "id": "1contr11-2222",
      "status": "sent",
      "title": "Loan Agreement - Saver package",
      "metadata": "ID0001",
      "source": "api",
      "test": "no",
      "signers": [
        {
          "id": "6signer6-9999",
          "name": "Benny Bell",
          "email": "benny@me.com",
          "mobile": "+12481234567",
          "company_name": "ACME Corp",
          "sign_page_url": "https://esignatures.com/sign/6signer6-9999"
        }
      ]
    }
  }
}
```

--------------------------------

### Query Contract Response

Source: https://esignatures.com/docs/api#esignatures-api

JSON response containing contract metadata, status, and signer information.

```json
{
  "data": {
    "contract":{
      "id": "1contr11-2222",
      "status": "sent",
      "title": "Rental Agreement",
      "metadata": "ID0001",
      "source": "api",
      "test": "no",
      "contract_pdf_url": "https://aws.com/contracts/1contr11-2222?authx=x123y",
      "labels": ["MA", "Rental"],
      "signers": [
        {
          "id": "6signer6-9999",
          "name": "Sam Signer",
          "email": "sam@tenants.com",
          "mobile": "+12481234567",
          "company_name": "ACME Corp",
          "sign_page_url": "https://esignatures.com/sign/6signer6-9999",
          "signer_field_values": {
            "city": "Boston",
            "preferred_contact": "Phone"
          }
        }
      ]
    }
  }
}
```

--------------------------------

### Retrieve Contract Content

Source: https://esignatures.com/docs/api

Fetches the Markdown content of a specific contract using its unique ID.

```http
GET /api/contracts/<contract_id>/content HTTP/1.1
```

```bash
curl -X GET 'https://esignatures.com/api/contracts/1contr11-2222/content' -u 'your-secret-token:'
```

```json
{
  "data": {
    "contract_id": "1contr11-2222",
    "markdown": "# Terms\n\nThis document sets out the agreement between..."
  }
}
```

--------------------------------

### JSON Request Parameters

Source: https://esignatures.com/docs/api

The structure of the JSON body for the update request, including the dry_run flag and the list of edits.

```json
{
  "dry_run":"no",
  "edits": [
    {
      "find_markdown": " including weekends.",
      "replace_with_markdown":" excluding weekends"
    },
    {
      "find_markdown": "# Additional clauses",
      "replace_with_markdown": "# Additional clauses\n\nThese will be the new additional conditions under the Additional clauses section."
    }
  ]
}
```

--------------------------------

### Duplicate Template Endpoint

Source: https://esignatures.com/docs/api

The HTTP POST request structure for duplicating a template.

```http
POST /api/templates/<template_id>/duplicate HTTP/1.1
```

--------------------------------

### POST /api/templates/<template_id>

Source: https://esignatures.com/docs/api

Updates the title and labels of an existing template.

```APIDOC
## POST /api/templates/<template_id>

### Description
Updates the template information.

### Method
POST

### Endpoint
/api/templates/<template_id>

### Parameters
#### Path Parameters
- **template_id** (string) - Required - The unique ID of the template.

#### Request Body
- **title** (string) - Optional - The title of the new template.
- **labels** (array) - Optional - Optional labels assigned to the template and its contracts.

### Request Example
{
  "title": "Rental Agreement",
  "labels": ["Generic templates", "Acme Client Corp"]
}

### Response
#### Success Response (200)
- **status** (string) - The status of the update operation.

### Response Example
{
  "status": "queued"
}
```

--------------------------------

### Query Contract Endpoint

Source: https://esignatures.com/docs/api#esignatures-api

The base endpoint structure for retrieving a specific contract by its ID.

```http
GET /api/contracts/<contract_id> HTTP/1.1
```

--------------------------------

### POST /api/contracts/<contract_id>/placeholder_fields

Source: https://esignatures.com/docs/api

Updates the placeholder field values for an unsigned contract.

```APIDOC
## POST /api/contracts/<contract_id>/placeholder_fields

### Description
Updates the Placeholder field values for an unsigned contract. Only the Placeholder fields included in the request are updated.

### Method
POST

### Endpoint
/api/contracts/<contract_id>/placeholder_fields

### Parameters
#### Path Parameters
- **contract_id** (string) - Required - The unique identifier of the contract.

#### Request Body
- **placeholder_fields** (array) - Required - List of Placeholder fields to update.
- **placeholder_key** (string) - Required - The key that corresponds to the placeholder text in the template.
- **replace_with_text** (string) - Optional - Plain text to replace the Placeholder field.
- **replace_with_markdown** (string) - Optional - Markdown content to replace the Placeholder field.
- **replace_with_template** (string) - Optional - Template ID of the template whose full content should replace the Placeholder field.

### Request Example
{
  "placeholder_fields": [
    {
      "placeholder_key": "package_name",
      "replace_with_text": "Premium"
    }
  ]
}

### Response
#### Success Response (200)
- **status** (string) - The status of the update request (e.g., 'queued').

### Response Example
{
  "status": "queued"
}
```

--------------------------------

### Signer signed the contract

Source: https://esignatures.com/docs/api

This webhook is triggered when a signer signs the contract. It includes signer details and the values entered by the signer for the input fields.

```APIDOC
## Signer signed the contract

### Description
This webhook is triggered when a signer signs the contract. It includes signer details and the values entered by the signer for the input fields.

### Response Example
{
  "status": "signer-signed",
  "data": {
    "signer": {
      "id": "6signer6-9999",
      "name": "Sam Signer",
      "email": "sam@tenants.com",
      "mobile": "+12481234567",
      "company_name": "ACME Corp",
      "signing_order": "1",
      "auto_sign": "no",
      "redirect_url": "",
      "signer_field_values": {
        "city": "Boston",
        "preferred_contact": "Phone"
      }
    },
    "contract": {
      "id": "1contr11-2222",
      "title": "Sample NDA",
      "metadata": "ID0001",
      "source": "api",
      "test": "no"
    }
  }
}
```

--------------------------------

### POST /api/templates/<template_id>/duplicate

Source: https://esignatures.com/docs/api

Duplicates an existing template and allows for content customization using Placeholder fields.

```APIDOC
## POST /api/templates/<template_id>/duplicate

### Description
Duplicates an existing template and allows for content customization using Placeholder fields.

### Method
POST

### Endpoint
/api/templates/<template_id>/duplicate

### Parameters
#### Path Parameters
- **template_id** (string) - Required - The ID of the template to duplicate.

#### Request Body
- **title** (string) - Required - The title for the new template.
- **placeholder_fields** (array) - Optional - Customizes the content of the new template by replacing Placeholder fields from the source template.
- **placeholder_fields.placeholder_key** (string) - Optional - The placeholder_key is the text between the curly brackets in the source contract template.
- **placeholder_fields.replace_with_text** (string) - Optional - Replace the Placeholder field in the new template with simple text.
- **placeholder_fields.replace_with_markdown** (string) - Optional - Markdown content to replace the placeholder field within the original template.
- **placeholder_fields.replace_with_template** (string) - Optional - Replace the Placeholder field in the new template with one of your existing template's full content.
- **target_secret_token** (string) - Optional - The API Secret token of another account, if the new template should be assigned to that other account.

### Request Example
{
  "title": "Rental Agreement",
  "placeholder_fields": [
    {
      "placeholder_key": "business_name",
      "replace_with_text": "ACME Co"
    }
  ],
  "target_secret_token": "another-accounts-secret-token"
}

### Response
#### Success Response (200)
- **data** (array) - List containing the new template ID.

#### Response Example
{
  "data": [
    {
      "template_id": "4templ44-6666"
    }
  ]
}
```

--------------------------------

### POST /api/templates/<template_id>/collaborators

Source: https://esignatures.com/docs/api

Adds a new collaborator to a template, allowing them to edit it.

```APIDOC
## POST /api/templates/<template_id>/collaborators

### Description
Adds a collaborator who can edit the template. The link to the editor can be used as a standalone page, or it can be embedded into an iframe by adding the embedded=yes URL parameter.

### Method
POST

### Endpoint
/api/templates/<template_id>/collaborators

### Parameters
#### Path Parameters
- **template_id** (string) - Required - The ID of the template.

#### Request Body
- **name** (string) - Optional - The name of the collaborator.
- **email** (string) - Optional - The email of the collaborator. Email invitation is sent when provided.

### Response
#### Success Response (200)
- **template_collaborator_id** (string) - The ID of the collaborator.
- **template_id** (string) - The ID of the template.
- **name** (string) - The name of the collaborator.
- **email** (string) - The email of the collaborator.
- **template_collaborator_editor_url** (string) - URL to access the template editor.

#### Response Example
{
  "data": [
    {
      "template_collaborator_id": "5templcoll5-7777",
      "template_id": "4templ44-6666",
      "name": "Chris Colleague",
      "email": "chris@acme.com",
      "template_collaborator_editor_url": "https://esignatures.com/contract_template_collaborators/5templcoll5-7777/editor"
    }
  ]
}
```

--------------------------------

### List Template Collaborators

Source: https://esignatures.com/docs/api

Retrieves a list of collaborators associated with a specific template ID.

```http
GET /api/templates/<template_id>/collaborators HTTP/1.1
```

```bash
curl -X GET 'https://esignatures.com/api/templates/4templ44-6666/collaborators' -u 'your-secret-token:'
```

```json
{
  "data": [
    {
      "template_collaborator_id": "5templcoll5-7777",
      "template_id": "4templ44-6666",
      "name": "Chris Colleague",
      "email": "chris@acme.com",
      "template_collaborator_editor_url": "https://esignatures.com/contract_template_collaborators/5templcoll5-7777/editor"
    }
  ]
}
```

--------------------------------

### Update Template Content Request

Source: https://esignatures.com/docs/api

The HTTP request structure for updating template content.

```http
POST /api/templates/<template_id>/content HTTP/1.1
```

--------------------------------

### POST /api/templates/<template_id>/content

Source: https://esignatures.com/docs/api

Updates the content of a specific template by applying a series of Markdown find-and-replace edits.

```APIDOC
## POST /api/templates/<template_id>/content

### Description
Updates the template content by applying a list of Markdown edit operations. Each edit finds existing content and replaces it with new Markdown.

### Method
POST

### Endpoint
/api/templates/<template_id>/content

### Parameters
#### Path Parameters
- **template_id** (string) - Required - The unique identifier of the template to update.

#### Request Body
- **dry_run** (string) - Optional - When 'yes', performs a dry run (no changes are saved).
- **edits** (array) - Required - List of Markdown edit operations applied to the template content.
- **edits:find_markdown** (string) - Required - Markdown content to find. Matches text literally or expands to a section if a heading is provided.
- **edits:replace_with_markdown** (string) - Required - Markdown content to insert in place of the matched content.

### Request Example
{
  "dry_run": "no",
  "edits": [
    {
      "find_markdown": " including weekends.",
      "replace_with_markdown": " excluding weekends"
    }
  ]
}

### Response
#### Success Response (200)
- **status** (string) - The status of the update operation.
- **data** (object) - Contains the updated markdown content.

#### Response Example
{
  "status": "updated",
  "data": {
    "markdown": "# Updated contract content here...\nNew terms..."
  }
}
```
Tokens:
Raw