DocEndorse - API Setup - Initiate Edit Session

Initiate Edit Session

Edit Session

/api/public/standalone/initiate_edit_session/v2

A successful call will create a copy of the underlying document that is linked to the template (Version 2) and generate tokens. The API call will return the tokens and the expiration date. The tokens will be used in subsequent API calls to edit the document, and to manage the document editor client side.

Headers

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

Parameters

Field	Description	Format
template_id	A required property that identifies the template that will be used. Template IDs are automatically created when a template is saved, and can be found by expanding the options of the templates table.	string
metadata	An optional entry that the user can add. This data will also be returned in webhooks.	array/dictionary
title	A required property that is used to identify the e-signature request.	string
recipients	A required list of recipients that will be party to the signing or editing process. Each item is a dictionary or an array containing: recipient_name [required] recipient_email [required] title_role [required] recipient_telephone [optional]	list of arrays/dictionaries

A CURL Request

CURL

 
curl -X POST https://docendorse.com/api/public/standalone/initiate_edit_session/v2 \
-H "Content-Type: application/json" \
-H "Authorization: Bearer " \
-d '{
    "template_id": "tempReq_61f99c245471ec",
    "recipients": [
        {
            "recipient_name": "Rick James",
            "recipient_email": "rickjames@example.com",
            "title_role": "Tenant"
        },
        {
            "recipient_name": "Rob King",
            "recipient_email": "rob.king@docendorse.com",
            "title_role": "Buyer"
        }
    ],
    "title": "Contract to lease apartment",
    "type": "integrated"
}'

Response

Response http status 200 OK

 
{
    status: string [status of the request]
    session_editor_token: string [used to make future edits to the document]
    session_viewer_token: string [used to grant the document viewer access]
    session_expiry_date: string [the date after which no further edits can be made]
    description: string [describes the result of the request]
    request_id: string [identifier for the request for future reference]                                    
}

Error

http status 40X

 
{
    status: error,
    description: error message
}