Issue

SendThroughWeb is not available in V6 REST API, however, it is available in V5.

Resolution

The sendThroughWeb allows you to send the agreement interactively. The various parameters in the “options” field in v5 POST /agreements request allow the user to configure this interactive view(Send page). All these page configuration parameters such as fileUploadOptions are moved to POST agreements/ID/views api.

So in effect, you can achieve sendThroughWeb by creating an agreement in AUTHORING state through POST /agreements API. Then, to ask for the url of the next page in desired configuration, call the POST agreements/ID/views API.

Do the following steps:

1. Go to REST API V6 documentation and select POST/agreements method.
2. Use the following request code:

{
  "fileInfos": [
    {
      "transientDocumentId": "***************************"
    }
  ],
  "name": "test",
  "participantSetsInfo": [
    {
      "memberInfos": [
        {
          "email": "abc@gmail.com"
        }
      ],
      "order": 1,
      "role": "SIGNER"
    }
  ],
  "signatureType": "ESIGN",
  "state": "AUTHORING"
}

3. Now, use the method post /agreements/{agreementId}/views with below request code:

{
  "name": "AUTHORING"
}

The response code provides the URL for authoring fields.

Additional information

https://secure.na1.echosign.com/public/docs/restapi/v6#!/agreements/createAgreementView

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy