MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking API Tokens on top right corner of your profile.

Documents

GET api/documents

requires authentication

Example request:
curl --request GET \
    --get "https://app.documerge.ai/api/documents" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.documerge.ai/api/documents"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/documents';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/documents'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "name": "test",
        "type": "html",
        "html_editor": "wysiwyg",
        "status": "Active",
        "output": "pdf",
        "file": {
            "id": 1,
            "url": "https://documergestaging.blob.core.windows.net/documergestaging/documentMerges/1/1/test_-_2024-03-21_9_00_am.pdf?sv=2017-11-09&sr=b&se=2024-03-23T13:17:16Z&sp=r&spr=https&sig=%2F3eXedXIExtttXF3K0Q8FmQ6q1B%2B%2BBeZ8YT5wtPxjYs%3D",
            "type": null,
            "description": null,
            "size": 27732,
            "mime": "application/pdf",
            "extension": "pdf",
            "source": "generated by system",
            "key": null,
            "created_via_api": 0,
            "created_at": "2024-03-21T13:00:09.000000Z",
            "updated_at": "2024-03-21T13:00:09.000000Z"
        },
        "timezone": "US/Eastern",
        "html": "<p>qwewewq</p>",
        "header_html": null,
        "footer_html": null,
        "size": "Letter",
        "size_width": 8.5,
        "size_height": 11,
        "orientation": "portrait",
        "image_dpi": 300,
        "add_watermark": 0,
        "watermark_text": null,
        "key": "1t1dLlvckO",
        "folder": null,
        "created_via_api": 0,
        "created_at": "2024-03-21T12:57:18.000000Z",
        "updated_at": "2024-03-21T12:57:36.000000Z"
    }
}

Request      

GET api/documents

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/documents

requires authentication

Example request:
curl --request POST \
    "https://app.documerge.ai/api/documents" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"quia\",
    \"type\": \"html\",
    \"output\": \"html\",
    \"status\": \"Inactive\"
}"

const url = new URL(
    "https://app.documerge.ai/api/documents"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "quia",
    "type": "html",
    "output": "html",
    "status": "Inactive"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/documents';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'quia',
            'type' => 'html',
            'output' => 'html',
            'status' => 'Inactive',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/documents'
payload = {
    "name": "quia",
    "type": "html",
    "output": "html",
    "status": "Inactive"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "name": "test",
        "type": "html",
        "html_editor": "wysiwyg",
        "status": "Active",
        "output": "pdf",
        "file": {
            "id": 1,
            "url": "https://documergestaging.blob.core.windows.net/documergestaging/documentMerges/1/1/test_-_2024-03-21_9_00_am.pdf?sv=2017-11-09&sr=b&se=2024-03-23T13:17:17Z&sp=r&spr=https&sig=A1BCQBXlumxDkI81juqdBRLDX8zaD62pIvNmOU1W5ik%3D",
            "type": null,
            "description": null,
            "size": 27732,
            "mime": "application/pdf",
            "extension": "pdf",
            "source": "generated by system",
            "key": null,
            "created_via_api": 0,
            "created_at": "2024-03-21T13:00:09.000000Z",
            "updated_at": "2024-03-21T13:00:09.000000Z"
        },
        "timezone": "US/Eastern",
        "html": "<p>qwewewq</p>",
        "header_html": null,
        "footer_html": null,
        "size": "Letter",
        "size_width": 8.5,
        "size_height": 11,
        "orientation": "portrait",
        "image_dpi": 300,
        "add_watermark": 0,
        "watermark_text": null,
        "key": "1t1dLlvckO",
        "folder": null,
        "created_via_api": 0,
        "created_at": "2024-03-21T12:57:18.000000Z",
        "updated_at": "2024-03-21T12:57:36.000000Z"
    }
}

Request      

POST api/documents

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Example: quia

type   string   

Example: html

Must be one of:
  • docx
  • pdf
  • xlsx
  • html
output   string   

Example: html

Must be one of:
  • docx
  • pdf
  • xlsx
  • html
  • email
  • jpeg
  • png
html   string  optional  
size_width   string  optional  
size_height   string  optional  
contents   string  optional  
folder   string  optional  
status   string  optional  

Example: Inactive

Must be one of:
  • Active
  • Inactive
  • Test Mode

GET api/documents/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://app.documerge.ai/api/documents/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.documerge.ai/api/documents/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/documents/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/documents/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "name": "test",
        "type": "html",
        "html_editor": "wysiwyg",
        "status": "Active",
        "output": "pdf",
        "file": {
            "id": 1,
            "url": "https://documergestaging.blob.core.windows.net/documergestaging/documentMerges/1/1/test_-_2024-03-21_9_00_am.pdf?sv=2017-11-09&sr=b&se=2024-03-23T13:17:17Z&sp=r&spr=https&sig=A1BCQBXlumxDkI81juqdBRLDX8zaD62pIvNmOU1W5ik%3D",
            "type": null,
            "description": null,
            "size": 27732,
            "mime": "application/pdf",
            "extension": "pdf",
            "source": "generated by system",
            "key": null,
            "created_via_api": 0,
            "created_at": "2024-03-21T13:00:09.000000Z",
            "updated_at": "2024-03-21T13:00:09.000000Z"
        },
        "timezone": "US/Eastern",
        "html": "<p>qwewewq</p>",
        "header_html": null,
        "footer_html": null,
        "size": "Letter",
        "size_width": 8.5,
        "size_height": 11,
        "orientation": "portrait",
        "image_dpi": 300,
        "add_watermark": 0,
        "watermark_text": null,
        "key": "1t1dLlvckO",
        "folder": null,
        "created_via_api": 0,
        "created_at": "2024-03-21T12:57:18.000000Z",
        "updated_at": "2024-03-21T12:57:36.000000Z"
    }
}

Request      

GET api/documents/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the document. Example: 1

PUT api/documents/{id}

requires authentication

Example request:
curl --request PUT \
    "https://app.documerge.ai/api/documents/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"voluptas\",
    \"type\": \"docx\",
    \"output\": \"xlsx\",
    \"status\": \"Test Mode\"
}"

const url = new URL(
    "https://app.documerge.ai/api/documents/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "voluptas",
    "type": "docx",
    "output": "xlsx",
    "status": "Test Mode"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/documents/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'voluptas',
            'type' => 'docx',
            'output' => 'xlsx',
            'status' => 'Test Mode',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/documents/1'
payload = {
    "name": "voluptas",
    "type": "docx",
    "output": "xlsx",
    "status": "Test Mode"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "name": "test",
        "type": "html",
        "html_editor": "wysiwyg",
        "status": "Active",
        "output": "pdf",
        "file": {
            "id": 1,
            "url": "https://documergestaging.blob.core.windows.net/documergestaging/documentMerges/1/1/test_-_2024-03-21_9_00_am.pdf?sv=2017-11-09&sr=b&se=2024-03-23T13:17:17Z&sp=r&spr=https&sig=A1BCQBXlumxDkI81juqdBRLDX8zaD62pIvNmOU1W5ik%3D",
            "type": null,
            "description": null,
            "size": 27732,
            "mime": "application/pdf",
            "extension": "pdf",
            "source": "generated by system",
            "key": null,
            "created_via_api": 0,
            "created_at": "2024-03-21T13:00:09.000000Z",
            "updated_at": "2024-03-21T13:00:09.000000Z"
        },
        "timezone": "US/Eastern",
        "html": "<p>qwewewq</p>",
        "header_html": null,
        "footer_html": null,
        "size": "Letter",
        "size_width": 8.5,
        "size_height": 11,
        "orientation": "portrait",
        "image_dpi": 300,
        "add_watermark": 0,
        "watermark_text": null,
        "key": "1t1dLlvckO",
        "folder": null,
        "created_via_api": 0,
        "created_at": "2024-03-21T12:57:18.000000Z",
        "updated_at": "2024-03-21T12:57:36.000000Z"
    }
}

Request      

PUT api/documents/{id}

PATCH api/documents/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the document. Example: 1

Body Parameters

name   string   

Example: voluptas

type   string   

Example: docx

Must be one of:
  • docx
  • pdf
  • xlsx
  • html
output   string   

Example: xlsx

Must be one of:
  • docx
  • pdf
  • xlsx
  • html
  • email
  • jpeg
  • png
html   string  optional  
size_width   string  optional  
size_height   string  optional  
contents   string  optional  
folder   string  optional  
status   string  optional  

Example: Test Mode

Must be one of:
  • Active
  • Inactive
  • Test Mode

DELETE api/documents/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://app.documerge.ai/api/documents/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.documerge.ai/api/documents/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/documents/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/documents/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (204):

Empty response

Request      

DELETE api/documents/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the document. Example: 1

GET api/documents/files/{document_id}

requires authentication

Example request:
curl --request GET \
    --get "https://app.documerge.ai/api/documents/files/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.documerge.ai/api/documents/files/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/documents/files/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/documents/files/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "url": null,
        "type": "html",
        "description": null,
        "size": "Letter",
        "mime": null,
        "extension": null,
        "source": null,
        "key": "1t1dLlvckO",
        "created_via_api": 0,
        "created_at": "2024-03-21T12:57:18.000000Z",
        "updated_at": "2024-03-21T12:57:36.000000Z"
    }
}

Request      

GET api/documents/files/{document_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

document_id   integer   

The ID of the document. Example: 1

POST api/documents/copy/{document_id}

requires authentication

Example request:
curl --request POST \
    "https://app.documerge.ai/api/documents/copy/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vqqnarajqjzexyahgjkmuge\"
}"

const url = new URL(
    "https://app.documerge.ai/api/documents/copy/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vqqnarajqjzexyahgjkmuge"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/documents/copy/1';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'vqqnarajqjzexyahgjkmuge',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/documents/copy/1'
payload = {
    "name": "vqqnarajqjzexyahgjkmuge"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "name": "test",
        "type": "html",
        "html_editor": "wysiwyg",
        "status": "Active",
        "output": "pdf",
        "file": {
            "id": 1,
            "url": "https://documergestaging.blob.core.windows.net/documergestaging/documentMerges/1/1/test_-_2024-03-21_9_00_am.pdf?sv=2017-11-09&sr=b&se=2024-03-23T13:17:17Z&sp=r&spr=https&sig=A1BCQBXlumxDkI81juqdBRLDX8zaD62pIvNmOU1W5ik%3D",
            "type": null,
            "description": null,
            "size": 27732,
            "mime": "application/pdf",
            "extension": "pdf",
            "source": "generated by system",
            "key": null,
            "created_via_api": 0,
            "created_at": "2024-03-21T13:00:09.000000Z",
            "updated_at": "2024-03-21T13:00:09.000000Z"
        },
        "timezone": "US/Eastern",
        "html": "<p>qwewewq</p>",
        "header_html": null,
        "footer_html": null,
        "size": "Letter",
        "size_width": 8.5,
        "size_height": 11,
        "orientation": "portrait",
        "image_dpi": 300,
        "add_watermark": 0,
        "watermark_text": null,
        "key": "1t1dLlvckO",
        "folder": null,
        "created_via_api": 0,
        "created_at": "2024-03-21T12:57:18.000000Z",
        "updated_at": "2024-03-21T12:57:36.000000Z"
    }
}

Request      

POST api/documents/copy/{document_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

document_id   integer   

The ID of the document. Example: 1

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vqqnarajqjzexyahgjkmuge

POST api/documents/merge/{key}

requires authentication

Example request:
curl --request POST \
    "https://app.documerge.ai/api/documents/merge/officia" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.documerge.ai/api/documents/merge/officia"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/documents/merge/officia';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/documents/merge/officia'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Example response (200):


{
 "message": 'Document merge queued!',
}

Request      

POST api/documents/merge/{key}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

key   string   

Example: officia

Document Fields

GET api/documents/fields/{document_id}

requires authentication

Example request:
curl --request GET \
    --get "https://app.documerge.ai/api/documents/fields/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.documerge.ai/api/documents/fields/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/documents/fields/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/documents/fields/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "name": "test",
        "field_map": null,
        "document_id": null,
        "route_id": null,
        "created_via_api": 0,
        "created_at": "2024-03-21T12:57:18.000000Z",
        "updated_at": "2024-03-21T12:57:36.000000Z"
    }
}

Request      

GET api/documents/fields/{document_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

document_id   integer   

The ID of the document. Example: 1

POST api/documents/fields/{document_id}

requires authentication

Example request:
curl --request POST \
    "https://app.documerge.ai/api/documents/fields/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"qui\"
}"

const url = new URL(
    "https://app.documerge.ai/api/documents/fields/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "qui"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/documents/fields/1';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'qui',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/documents/fields/1'
payload = {
    "name": "qui"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "name": "test",
        "field_map": null,
        "document_id": null,
        "route_id": null,
        "created_via_api": 0,
        "created_at": "2024-03-21T12:57:18.000000Z",
        "updated_at": "2024-03-21T12:57:36.000000Z"
    }
}

Request      

POST api/documents/fields/{document_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

document_id   integer   

The ID of the document. Example: 1

Body Parameters

name   string   

Example: qui

field_map   string  optional  

PUT api/documents/fields/{document_id}/{field_id}

requires authentication

Example request:
curl --request PUT \
    "https://app.documerge.ai/api/documents/fields/1/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"molestias\"
}"

const url = new URL(
    "https://app.documerge.ai/api/documents/fields/1/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "molestias"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/documents/fields/1/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'molestias',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/documents/fields/1/1'
payload = {
    "name": "molestias"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "name": "test",
        "field_map": null,
        "document_id": null,
        "route_id": null,
        "created_via_api": 0,
        "created_at": "2024-03-21T12:57:18.000000Z",
        "updated_at": "2024-03-21T12:57:36.000000Z"
    }
}

Request      

PUT api/documents/fields/{document_id}/{field_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

document_id   integer   

The ID of the document. Example: 1

field_id   integer   

The ID of the field. Example: 1

Body Parameters

name   string   

Example: molestias

field_map   string  optional  

DELETE api/documents/fields/{document_id}/{field_id}

requires authentication

Example request:
curl --request DELETE \
    "https://app.documerge.ai/api/documents/fields/1/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.documerge.ai/api/documents/fields/1/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/documents/fields/1/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/documents/fields/1/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (204):

Empty response

Request      

DELETE api/documents/fields/{document_id}/{field_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

document_id   integer   

The ID of the document. Example: 1

field_id   integer   

The ID of the field. Example: 1

Delivery Methods

GET api/documents/delivery-methods/{document_id}

requires authentication

Example request:
curl --request GET \
    --get "https://app.documerge.ai/api/documents/delivery-methods/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.documerge.ai/api/documents/delivery-methods/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/documents/delivery-methods/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/documents/delivery-methods/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "document_id": 1,
        "route_id": null,
        "type": "webhook",
        "settings": {
            "always_send": true,
            "send_if_conditions": [
                {
                    "key": "42b386cb-86e3-4f97-b9ae-2c59dc6f746a",
                    "andOrOperator": "and",
                    "field": null,
                    "comparisonOperator": null,
                    "value": null
                }
            ],
            "signees": [
                {
                    "key": "309d48d3-38d8-42fd-b49b-c0bfa7581bb7",
                    "name": null,
                    "email": null,
                    "signee_role": "signer"
                }
            ],
            "url": "https://hooks.zapier.com/hooks/standard/18104765/6899fd2e9382424ba462d0630082d65c/",
            "send_temporary_download_url": true,
            "send_data_using_json": true,
            "send_merge_data": true,
            "append_merge_data_to_webhook_url": true,
            "add_extra_post_parameters": false
        },
        "created_via_api": 0,
        "created_at": "2024-03-21T13:03:39.000000Z",
        "updated_at": "2024-03-23T10:13:22.000000Z"
    }
}

Request      

GET api/documents/delivery-methods/{document_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

document_id   integer   

The ID of the document. Example: 1

POST api/documents/delivery-methods/{document_id}

requires authentication

Example request:
curl --request POST \
    "https://app.documerge.ai/api/documents/delivery-methods/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"aperiam\",
    \"settings\": \"tempore\"
}"

const url = new URL(
    "https://app.documerge.ai/api/documents/delivery-methods/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "aperiam",
    "settings": "tempore"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/documents/delivery-methods/1';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'type' => 'aperiam',
            'settings' => 'tempore',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/documents/delivery-methods/1'
payload = {
    "type": "aperiam",
    "settings": "tempore"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "document_id": 1,
        "route_id": null,
        "type": "webhook",
        "settings": {
            "always_send": true,
            "send_if_conditions": [
                {
                    "key": "42b386cb-86e3-4f97-b9ae-2c59dc6f746a",
                    "andOrOperator": "and",
                    "field": null,
                    "comparisonOperator": null,
                    "value": null
                }
            ],
            "signees": [
                {
                    "key": "309d48d3-38d8-42fd-b49b-c0bfa7581bb7",
                    "name": null,
                    "email": null,
                    "signee_role": "signer"
                }
            ],
            "url": "https://hooks.zapier.com/hooks/standard/18104765/6899fd2e9382424ba462d0630082d65c/",
            "send_temporary_download_url": true,
            "send_data_using_json": true,
            "send_merge_data": true,
            "append_merge_data_to_webhook_url": true,
            "add_extra_post_parameters": false
        },
        "created_via_api": 0,
        "created_at": "2024-03-21T13:03:39.000000Z",
        "updated_at": "2024-03-23T10:13:22.000000Z"
    }
}

Request      

POST api/documents/delivery-methods/{document_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

document_id   integer   

The ID of the document. Example: 1

Body Parameters

type   string   

Example: aperiam

settings   string   

Example: tempore

PUT api/documents/delivery-methods/{document_id}/{deliveryMethod_id}

requires authentication

Example request:
curl --request PUT \
    "https://app.documerge.ai/api/documents/delivery-methods/1/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"recusandae\",
    \"settings\": \"qui\"
}"

const url = new URL(
    "https://app.documerge.ai/api/documents/delivery-methods/1/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "recusandae",
    "settings": "qui"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/documents/delivery-methods/1/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'type' => 'recusandae',
            'settings' => 'qui',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/documents/delivery-methods/1/1'
payload = {
    "type": "recusandae",
    "settings": "qui"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "document_id": 1,
        "route_id": null,
        "type": "webhook",
        "settings": {
            "always_send": true,
            "send_if_conditions": [
                {
                    "key": "42b386cb-86e3-4f97-b9ae-2c59dc6f746a",
                    "andOrOperator": "and",
                    "field": null,
                    "comparisonOperator": null,
                    "value": null
                }
            ],
            "signees": [
                {
                    "key": "309d48d3-38d8-42fd-b49b-c0bfa7581bb7",
                    "name": null,
                    "email": null,
                    "signee_role": "signer"
                }
            ],
            "url": "https://hooks.zapier.com/hooks/standard/18104765/6899fd2e9382424ba462d0630082d65c/",
            "send_temporary_download_url": true,
            "send_data_using_json": true,
            "send_merge_data": true,
            "append_merge_data_to_webhook_url": true,
            "add_extra_post_parameters": false
        },
        "created_via_api": 0,
        "created_at": "2024-03-21T13:03:39.000000Z",
        "updated_at": "2024-03-23T10:13:22.000000Z"
    }
}

Request      

PUT api/documents/delivery-methods/{document_id}/{deliveryMethod_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

document_id   integer   

The ID of the document. Example: 1

deliveryMethod_id   integer   

The ID of the deliveryMethod. Example: 1

Body Parameters

type   string   

Example: recusandae

settings   string   

Example: qui

DELETE api/documents/delivery-methods/{document_id}/{deliveryMethod_id}

requires authentication

Example request:
curl --request DELETE \
    "https://app.documerge.ai/api/documents/delivery-methods/1/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.documerge.ai/api/documents/delivery-methods/1/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/documents/delivery-methods/1/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/documents/delivery-methods/1/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (204):

Empty response

Request      

DELETE api/documents/delivery-methods/{document_id}/{deliveryMethod_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

document_id   integer   

The ID of the document. Example: 1

deliveryMethod_id   integer   

The ID of the deliveryMethod. Example: 1

Routes

GET api/routes

requires authentication

Example request:
curl --request GET \
    --get "https://app.documerge.ai/api/routes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.documerge.ai/api/routes"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/routes';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/routes'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": null,
        "name": null,
        "folder": null,
        "rules": [],
        "status": null,
        "file_name": null,
        "key": null,
        "created_via_api": null,
        "created_at": null,
        "updated_at": null
    }
}

Request      

GET api/routes

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/routes

requires authentication

Example request:
curl --request POST \
    "https://app.documerge.ai/api/routes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"qui\"
}"

const url = new URL(
    "https://app.documerge.ai/api/routes"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "qui"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/routes';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'qui',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/routes'
payload = {
    "name": "qui"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": null,
        "name": null,
        "folder": null,
        "rules": [],
        "status": null,
        "file_name": null,
        "key": null,
        "created_via_api": null,
        "created_at": null,
        "updated_at": null
    }
}

Request      

POST api/routes

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Example: qui

output_name   string  optional  
folder   string  optional  
timezone   string  optional  
add_watermark   string  optional  
watermark_text   string  optional  
rules   string[]  optional  
document_id   string  optional  
file   string  optional  

This field is required when rules.document_id is null.

include_in_combined_pdf   boolean  optional  

Example: false

include_in_combined_docx   boolean  optional  

Example: false

include_in_combined_xlsx   boolean  optional  

Example: true

repeat_this_rule   boolean  optional  

Example: true

sort   string  optional  
loop_field   string  optional  
conditions   string  optional  
custom_file   string  optional  
url   string  optional  

Must be a valid URL. Example: http://leuschke.com/et-quod-laudantium-quisquam-consequuntur

GET api/routes/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://app.documerge.ai/api/routes/13" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.documerge.ai/api/routes/13"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/routes/13';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/routes/13'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": null,
        "name": null,
        "folder": null,
        "rules": [],
        "status": null,
        "file_name": null,
        "key": null,
        "created_via_api": null,
        "created_at": null,
        "updated_at": null
    }
}

Request      

GET api/routes/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the route. Example: 13

PUT api/routes/{id}

requires authentication

Example request:
curl --request PUT \
    "https://app.documerge.ai/api/routes/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"et\"
}"

const url = new URL(
    "https://app.documerge.ai/api/routes/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "et"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/routes/3';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'et',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/routes/3'
payload = {
    "name": "et"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": null,
        "name": null,
        "folder": null,
        "rules": [],
        "status": null,
        "file_name": null,
        "key": null,
        "created_via_api": null,
        "created_at": null,
        "updated_at": null
    }
}

Request      

PUT api/routes/{id}

PATCH api/routes/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the route. Example: 3

Body Parameters

name   string   

Example: et

output_name   string  optional  
folder   string  optional  
timezone   string  optional  
add_watermark   string  optional  
watermark_text   string  optional  
rules   string[]  optional  
document_id   string  optional  
file   string  optional  

This field is required when rules.document_id is null.

include_in_combined_pdf   boolean  optional  

Example: false

include_in_combined_docx   boolean  optional  

Example: false

include_in_combined_xlsx   boolean  optional  

Example: true

repeat_this_rule   boolean  optional  

Example: true

sort   string  optional  
loop_field   string  optional  
conditions   string  optional  
custom_file   string  optional  
url   string  optional  

Must be a valid URL. Example: http://www.gleichner.com/

DELETE api/routes/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://app.documerge.ai/api/routes/6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.documerge.ai/api/routes/6"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/routes/6';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/routes/6'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (204):

Empty response

Request      

DELETE api/routes/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the route. Example: 6

GET api/routes/{route_id}/rules

requires authentication

Example request:
curl --request GET \
    --get "https://app.documerge.ai/api/routes/15/rules" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.documerge.ai/api/routes/15/rules"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/routes/15/rules';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/routes/15/rules'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": null,
        "document_id": null,
        "custom_file": null,
        "sort": null,
        "document": null,
        "include_in_combined_pdf": null,
        "include_in_combined_docx": null,
        "include_in_combined_xlsx": null,
        "repeat_this_rule": null,
        "loop_field": null,
        "conditions": null,
        "created_via_api": null,
        "created_at": null,
        "updated_at": null
    }
}

Request      

GET api/routes/{route_id}/rules

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

route_id   integer   

The ID of the route. Example: 15

POST api/routes/merge/{key}

requires authentication

Example request:
curl --request POST \
    "https://app.documerge.ai/api/routes/merge/qui" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.documerge.ai/api/routes/merge/qui"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/routes/merge/qui';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/routes/merge/qui'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Example response (200):


{
 "message": 'Route merge queued!',
}

Request      

POST api/routes/merge/{key}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

key   string   

Example: qui

Fields

GET api/routes/fields/{route_id}

requires authentication

Example request:
curl --request GET \
    --get "https://app.documerge.ai/api/routes/fields/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.documerge.ai/api/routes/fields/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/routes/fields/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/routes/fields/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "name": "test",
        "field_map": null,
        "document_id": 1,
        "route_id": null,
        "created_via_api": 0,
        "created_at": "2024-03-21T12:57:46.000000Z",
        "updated_at": "2024-03-21T12:57:46.000000Z"
    }
}

Request      

GET api/routes/fields/{route_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

route_id   integer   

The ID of the route. Example: 1

POST api/routes/fields/{route_id}

requires authentication

Example request:
curl --request POST \
    "https://app.documerge.ai/api/routes/fields/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"aut\"
}"

const url = new URL(
    "https://app.documerge.ai/api/routes/fields/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "aut"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/routes/fields/1';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'aut',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/routes/fields/1'
payload = {
    "name": "aut"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "name": "test",
        "field_map": null,
        "document_id": 1,
        "route_id": null,
        "created_via_api": 0,
        "created_at": "2024-03-21T12:57:46.000000Z",
        "updated_at": "2024-03-21T12:57:46.000000Z"
    }
}

Request      

POST api/routes/fields/{route_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

route_id   integer   

The ID of the route. Example: 1

Body Parameters

name   string   

Example: aut

field_map   string  optional  

PUT api/routes/fields/{route_id}/{field_id}

requires authentication

Example request:
curl --request PUT \
    "https://app.documerge.ai/api/routes/fields/1/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"voluptatibus\"
}"

const url = new URL(
    "https://app.documerge.ai/api/routes/fields/1/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "voluptatibus"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/routes/fields/1/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'voluptatibus',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/routes/fields/1/1'
payload = {
    "name": "voluptatibus"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "name": "test",
        "field_map": null,
        "document_id": 1,
        "route_id": null,
        "created_via_api": 0,
        "created_at": "2024-03-21T12:57:46.000000Z",
        "updated_at": "2024-03-21T12:57:46.000000Z"
    }
}

Request      

PUT api/routes/fields/{route_id}/{field_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

route_id   integer   

The ID of the route. Example: 1

field_id   integer   

The ID of the field. Example: 1

Body Parameters

name   string   

Example: voluptatibus

field_map   string  optional  

DELETE api/routes/fields/{route_id}/{field_id}

requires authentication

Example request:
curl --request DELETE \
    "https://app.documerge.ai/api/routes/fields/1/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.documerge.ai/api/routes/fields/1/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/routes/fields/1/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/routes/fields/1/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (204):

Empty response

Request      

DELETE api/routes/fields/{route_id}/{field_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

route_id   integer   

The ID of the route. Example: 1

field_id   integer   

The ID of the field. Example: 1

Delivery Methods

GET api/routes/delivery-methods/{route_id}

requires authentication

Example request:
curl --request GET \
    --get "https://app.documerge.ai/api/routes/delivery-methods/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.documerge.ai/api/routes/delivery-methods/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/routes/delivery-methods/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/routes/delivery-methods/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "document_id": 1,
        "route_id": null,
        "type": "webhook",
        "settings": {
            "always_send": true,
            "send_if_conditions": [
                {
                    "key": "42b386cb-86e3-4f97-b9ae-2c59dc6f746a",
                    "andOrOperator": "and",
                    "field": null,
                    "comparisonOperator": null,
                    "value": null
                }
            ],
            "signees": [
                {
                    "key": "309d48d3-38d8-42fd-b49b-c0bfa7581bb7",
                    "name": null,
                    "email": null,
                    "signee_role": "signer"
                }
            ],
            "url": "https://hooks.zapier.com/hooks/standard/18104765/6899fd2e9382424ba462d0630082d65c/",
            "send_temporary_download_url": true,
            "send_data_using_json": true,
            "send_merge_data": true,
            "append_merge_data_to_webhook_url": true,
            "add_extra_post_parameters": false
        },
        "created_via_api": 0,
        "created_at": "2024-03-21T13:03:39.000000Z",
        "updated_at": "2024-03-23T10:13:22.000000Z"
    }
}

Request      

GET api/routes/delivery-methods/{route_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

route_id   integer   

The ID of the route. Example: 1

POST api/routes/delivery-methods/{route_id}

requires authentication

Example request:
curl --request POST \
    "https://app.documerge.ai/api/routes/delivery-methods/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"molestias\",
    \"settings\": \"qui\"
}"

const url = new URL(
    "https://app.documerge.ai/api/routes/delivery-methods/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "molestias",
    "settings": "qui"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/routes/delivery-methods/1';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'type' => 'molestias',
            'settings' => 'qui',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/routes/delivery-methods/1'
payload = {
    "type": "molestias",
    "settings": "qui"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "document_id": 1,
        "route_id": null,
        "type": "webhook",
        "settings": {
            "always_send": true,
            "send_if_conditions": [
                {
                    "key": "42b386cb-86e3-4f97-b9ae-2c59dc6f746a",
                    "andOrOperator": "and",
                    "field": null,
                    "comparisonOperator": null,
                    "value": null
                }
            ],
            "signees": [
                {
                    "key": "309d48d3-38d8-42fd-b49b-c0bfa7581bb7",
                    "name": null,
                    "email": null,
                    "signee_role": "signer"
                }
            ],
            "url": "https://hooks.zapier.com/hooks/standard/18104765/6899fd2e9382424ba462d0630082d65c/",
            "send_temporary_download_url": true,
            "send_data_using_json": true,
            "send_merge_data": true,
            "append_merge_data_to_webhook_url": true,
            "add_extra_post_parameters": false
        },
        "created_via_api": 0,
        "created_at": "2024-03-21T13:03:39.000000Z",
        "updated_at": "2024-03-23T10:13:22.000000Z"
    }
}

Request      

POST api/routes/delivery-methods/{route_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

route_id   integer   

The ID of the route. Example: 1

Body Parameters

type   string   

Example: molestias

settings   string   

Example: qui

PUT api/routes/delivery-methods/{route_id}/{deliveryMethod_id}

requires authentication

Example request:
curl --request PUT \
    "https://app.documerge.ai/api/routes/delivery-methods/1/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"asperiores\",
    \"settings\": \"ut\"
}"

const url = new URL(
    "https://app.documerge.ai/api/routes/delivery-methods/1/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "asperiores",
    "settings": "ut"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/routes/delivery-methods/1/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'type' => 'asperiores',
            'settings' => 'ut',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/routes/delivery-methods/1/1'
payload = {
    "type": "asperiores",
    "settings": "ut"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "document_id": 1,
        "route_id": null,
        "type": "webhook",
        "settings": {
            "always_send": true,
            "send_if_conditions": [
                {
                    "key": "42b386cb-86e3-4f97-b9ae-2c59dc6f746a",
                    "andOrOperator": "and",
                    "field": null,
                    "comparisonOperator": null,
                    "value": null
                }
            ],
            "signees": [
                {
                    "key": "309d48d3-38d8-42fd-b49b-c0bfa7581bb7",
                    "name": null,
                    "email": null,
                    "signee_role": "signer"
                }
            ],
            "url": "https://hooks.zapier.com/hooks/standard/18104765/6899fd2e9382424ba462d0630082d65c/",
            "send_temporary_download_url": true,
            "send_data_using_json": true,
            "send_merge_data": true,
            "append_merge_data_to_webhook_url": true,
            "add_extra_post_parameters": false
        },
        "created_via_api": 0,
        "created_at": "2024-03-21T13:03:39.000000Z",
        "updated_at": "2024-03-23T10:13:22.000000Z"
    }
}

Request      

PUT api/routes/delivery-methods/{route_id}/{deliveryMethod_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

route_id   integer   

The ID of the route. Example: 1

deliveryMethod_id   integer   

The ID of the deliveryMethod. Example: 1

Body Parameters

type   string   

Example: asperiores

settings   string   

Example: ut

DELETE api/routes/delivery-methods/{route_id}/{deliveryMethod_id}

requires authentication

Example request:
curl --request DELETE \
    "https://app.documerge.ai/api/routes/delivery-methods/1/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://app.documerge.ai/api/routes/delivery-methods/1/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/routes/delivery-methods/1/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/routes/delivery-methods/1/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (204):

Empty response

Request      

DELETE api/routes/delivery-methods/{route_id}/{deliveryMethod_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

route_id   integer   

The ID of the route. Example: 1

deliveryMethod_id   integer   

The ID of the deliveryMethod. Example: 1

Tools

POST api/tools/combine

requires authentication

Example request:
curl --request POST \
    "https://app.documerge.ai/api/tools/combine" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"output\": \"pdf\",
    \"files\": [
        \"non\"
    ]
}"

const url = new URL(
    "https://app.documerge.ai/api/tools/combine"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "output": "pdf",
    "files": [
        "non"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/tools/combine';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'output' => 'pdf',
            'files' => [
                'non',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/tools/combine'
payload = {
    "output": "pdf",
    "files": [
        "non"
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

Binary data -  The combined file (pdf or docx).

Request      

POST api/tools/combine

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

output   string   

Example: pdf

Must be one of:
  • pdf
  • docx
files   string[]   
name   string   

Example: qui

url   string  optional  

Must be a valid URL. Example: https://www.renner.com/facere-modi-qui-qui-rerum-enim

contents   string  optional  

POST api/tools/pdf/compress

requires authentication

Example request:
curl --request POST \
    "https://app.documerge.ai/api/tools/pdf/compress" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"file\": {
        \"name\": \"quam\",
        \"url\": \"http:\\/\\/nitzsche.info\\/id-omnis-consectetur-laboriosam-consectetur-quisquam\"
    }
}"

const url = new URL(
    "https://app.documerge.ai/api/tools/pdf/compress"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "file": {
        "name": "quam",
        "url": "http:\/\/nitzsche.info\/id-omnis-consectetur-laboriosam-consectetur-quisquam"
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/tools/pdf/compress';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'file' => [
                'name' => 'quam',
                'url' => 'http://nitzsche.info/id-omnis-consectetur-laboriosam-consectetur-quisquam',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/tools/pdf/compress'
payload = {
    "file": {
        "name": "quam",
        "url": "http:\/\/nitzsche.info\/id-omnis-consectetur-laboriosam-consectetur-quisquam"
    }
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

Binary data -  Compressed PDF file.

Request      

POST api/tools/pdf/compress

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

file   object  optional  
name   string   

Example: quam

url   string  optional  

Must be a valid URL. Example: http://nitzsche.info/id-omnis-consectetur-laboriosam-consectetur-quisquam

contents   string  optional  

POST api/tools/pdf/convert

requires authentication

Example request:
curl --request POST \
    "https://app.documerge.ai/api/tools/pdf/convert" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"file\": {
        \"name\": \"quis\",
        \"url\": \"http:\\/\\/hermiston.com\\/dicta-at-quasi-vitae-et-fugiat-sequi-debitis-sit\"
    }
}"

const url = new URL(
    "https://app.documerge.ai/api/tools/pdf/convert"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "file": {
        "name": "quis",
        "url": "http:\/\/hermiston.com\/dicta-at-quasi-vitae-et-fugiat-sequi-debitis-sit"
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/tools/pdf/convert';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'file' => [
                'name' => 'quis',
                'url' => 'http://hermiston.com/dicta-at-quasi-vitae-et-fugiat-sequi-debitis-sit',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/tools/pdf/convert'
payload = {
    "file": {
        "name": "quis",
        "url": "http:\/\/hermiston.com\/dicta-at-quasi-vitae-et-fugiat-sequi-debitis-sit"
    }
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

Binary data -  Converted PDF file.

Request      

POST api/tools/pdf/convert

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

file   object  optional  
name   string   

Example: quis

url   string  optional  

Must be a valid URL. Example: http://hermiston.com/dicta-at-quasi-vitae-et-fugiat-sequi-debitis-sit

contents   string  optional  

POST api/tools/pdf/encrypt

requires authentication

Example request:
curl --request POST \
    "https://app.documerge.ai/api/tools/pdf/encrypt" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"file\": {
        \"name\": \"aut\",
        \"url\": \"http:\\/\\/daniel.com\\/voluptas-sunt-nihil-odio\"
    },
    \"password\": \"XOjrjFl\",
    \"user_password\": \"aut\",
    \"permissions\": []
}"

const url = new URL(
    "https://app.documerge.ai/api/tools/pdf/encrypt"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "file": {
        "name": "aut",
        "url": "http:\/\/daniel.com\/voluptas-sunt-nihil-odio"
    },
    "password": "XOjrjFl",
    "user_password": "aut",
    "permissions": []
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/tools/pdf/encrypt';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'file' => [
                'name' => 'aut',
                'url' => 'http://daniel.com/voluptas-sunt-nihil-odio',
            ],
            'password' => 'XOjrjFl',
            'user_password' => 'aut',
            'permissions' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/tools/pdf/encrypt'
payload = {
    "file": {
        "name": "aut",
        "url": "http:\/\/daniel.com\/voluptas-sunt-nihil-odio"
    },
    "password": "XOjrjFl",
    "user_password": "aut",
    "permissions": []
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

Binary data -  Encrypted PDF file.

Request      

POST api/tools/pdf/encrypt

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

file   object  optional  
name   string   

Example: aut

url   string  optional  

Must be a valid URL. Example: http://daniel.com/voluptas-sunt-nihil-odio

contents   string  optional  
password   string   

Example: XOjrjFl

user_password   string   

Example: aut

permissions   object   
Must be one of:
  • Printing
  • DegradedPrinting
  • ModifyContents
  • Assembly
  • CopyContents
  • FillIn
  • AllFeatures

POST api/tools/pdf/split

requires authentication

Example request:
curl --request POST \
    "https://app.documerge.ai/api/tools/pdf/split" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"file\": {
        \"name\": \"eos\",
        \"url\": \"http:\\/\\/mohr.com\\/magnam-fugit-facilis-molestiae-quo-rerum-accusamus-veniam.html\"
    },
    \"extract\": [
        \"332088-85869))))\"
    ],
    \"remove\": [
        \"),86-0059\"
    ]
}"

const url = new URL(
    "https://app.documerge.ai/api/tools/pdf/split"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "file": {
        "name": "eos",
        "url": "http:\/\/mohr.com\/magnam-fugit-facilis-molestiae-quo-rerum-accusamus-veniam.html"
    },
    "extract": [
        "332088-85869))))"
    ],
    "remove": [
        "),86-0059"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://app.documerge.ai/api/tools/pdf/split';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'file' => [
                'name' => 'eos',
                'url' => 'http://mohr.com/magnam-fugit-facilis-molestiae-quo-rerum-accusamus-veniam.html',
            ],
            'extract' => [
                '332088-85869))))',
            ],
            'remove' => [
                '),86-0059',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://app.documerge.ai/api/tools/pdf/split'
payload = {
    "file": {
        "name": "eos",
        "url": "http:\/\/mohr.com\/magnam-fugit-facilis-molestiae-quo-rerum-accusamus-veniam.html"
    },
    "extract": [
        "332088-85869))))"
    ],
    "remove": [
        "),86-0059"
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

Binary data -  Split PDF file.

Request      

POST api/tools/pdf/split

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

file   object  optional  
name   string   

Example: eos

url   string  optional  

Must be a valid URL. Example: http://mohr.com/magnam-fugit-facilis-molestiae-quo-rerum-accusamus-veniam.html

contents   string  optional  
extract   string[]  optional  

Must match the regex /^(\d+(-\d+)?)(,\s\d+(-\d+)?)$/.

remove   string[]  optional  

Must match the regex /^(\d+(-\d+)?)(,\s\d+(-\d+)?)$/.