Share the document

Requirements

  • Authentication token
  • Document ID

How to share the document

POST /share?token=:authenticationToken
  • You have to choose share purpose: vieweditsignexecuteapprovereview or accept
  • You can specify multiple recipients
  • You can also set the share link validity and private message to recipient.

Example

Request

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

Response

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