Go to REST API V6 documentation and select POST/agreements method.
Last updated on
Apr 27, 2021
Issue
In latest version V6 of REST API, the parameter "FormFields" is not available as available in V5.
Environment
REST API V6
Resolution
The v6 has a set of authoring API’s to author an agreement. In v5, the formFields are directly consumed in POST /agreements api. However, in v6 user can create an agreement in AUTHORING state (state = AUTHORING) through v6 POST /agreements and use PUT /agreements/ID/formFields at any later point of time to add form fields to the documents of this agreement.
Following are the steps:
-
-
Use the following request code:
{ "fileInfos": [ { "transientDocumentId": "***************************" } ], "name": "test", "participantSetsInfo": [ { "memberInfos": [ { "email": "abc@gmail.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "AUTHORING" } -
Use the method put /agreements/{agreementId}/formFields with the following request as sample:
{ "fields": [ { "locations": [ { "height": 36, "left": 75, "pageNumber": "1", "top": 200, "width": 150 } ], "contentType": "SIGNATURE_BLOCK", "name": "sigBlock1", "inputType": "SIGNATURE", "recipientIndex":1 } ]}It sends the agreement to mentioned recipient once the request is completed.
Additional information
https://secure.na1.echosign.com/public/docs/restapi/v6#!/agreements/updateFormFields
