Share the document

Requirements

Authentication token
Document ID

How to share the document

JS

POST /share?token=:authenticationToken

You can choose share purpose: view, edit, sign, execute, approve, review or accept
- view = user will have read-only rights to the document
- edit = user will have edit rights to the document
- sign = described in Request a signature
- approve/review/accept - described on our help page
You can specify multiple recipients
You can also set the share link validity and private message to recipient.

Example

In example below we are sharing a document to internal user (joe.simpson@circularo.com) with read-only rights

Request

JS

POST /share?token=ADFFQBYXP2NVGR6PAP3KOR27FETP6
{
    "objectType": "document",
    "type": "d_default",
    "id": "d148b19a-4fa9-442e-adfd-7aa68b8eb766",
    "data": [ //specify at least one recipient
        {
            "sharePurpose": "view",   //share purpose
            "shareTo": "joe.simpson@circularo.com",  //internal recipient
            "message": "Read me",  //optional private message
            "validUntil": "2020-02-12T19:10:10.100Z" //optional expiration date in ISO 8601 format
        }
    ]
}

Response

JS

[
    {
        "shareId": "a4khpa5qw6q2hdsdq6ly6q4epafh7ip8d0dfg4wer78kjj0sd54g9e5r4t0w4ui8",
        "isActive": true,
        "shareDate": "2020-02-11T16:16:16.150Z",
        "shareType": "sign",
        "sharedBy": "judy.corbett",
        "sharedObjectEsId": "d148b19a-4fa9-442e-adfd-7aa68b8eb766",
        "sharedObjectEsType": "d_default",
        "sharedObjectType": "document",
        "sharedWith": [ "joe.simpson@circularo.com" ],
        "otpEnabled": false,
        "passwordRequired": true,
        "sharedUsername": "joe.simpson",
        "privateMessage": "Read me",
        "validUntil": "2020-02-12T19:10:10.100Z"
    }
]