DocEndorse - API Setup - Edit Document

Edit Document

/api/public/standalone/edit_documents/v2

Make one or more request to add content to one or more documents.

Headers

Content-Type:application/json
Authorization: Bearer [user key: auth token]

Parameters

Field	Description	Format
document_id	The id of the original document used in the template. This is a required item.	integer
session_editor_token	A required item retrieved from the initiate edit session endpoint.	string
document_edits	A required list of document edits. Each item is a dictionary or an array containing: title_role: string [required] data_label: string [required] value: string\| integer \| boolean [required depending on element type] page: integer [required] recipient_email: string [required] hyperlink_uri: url [required depending on box type] selected_page: integer [required depending on box type] file_url: url [required depending on box type] description: string [required depending on box type]	list of [arrays]/dictionaries

A CURL Request

CURL

 
curl -X POST https://docendorse.com/api/public/standalone/edit_documents/v2 \
-H "Content-Type: application/json" \
-H "Authorization: Bearer " \
-d '{
    "session_editor_token": "",
    "document_id": 2880,
    "document_edits": [
        {
            "recipient_email": "rickjames@example.com",
            "data_label": "ContractTerms",
            "page": 1,
            "value": "These are the terms of the contract please honor them or we will go to court."
        }
    ]
}'

Response

Response http status 200 OK

 
{
    status: string [status of the request]
    description: string [describes the result of the request]
}

Error

http status 40X

 
{
    status: error,
    description: error message
}