Why the option "sendThroughWeb" is no longer available in Adobe Sign REST API v6 and what is the replacement? | Adobe Sign

Environment

Adobe Sign REST v6

Question

Why the option "sendThroughWeb" is no longer available in Adobe Sign REST API v6 like in v5 and what is the replacement?

Answer

Starting from v6, the option "sendTroughWeb" is no longer available. The state replaces it. It is the state in which the agreement lands. The state field can only be provided in POST calls. It never gets returned in GET /agreements/{ID} and is ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID.

state(string) = ['AUTHORING' or 'DRAFT' or 'IN_PROCESS'].

AUTHORING allows a user to author the documents of an agreement before sending them out. The authoring operation here refers to creating, editing, or placing form fields along with their configurations (assignee, conditions, data type, and so on.) in the agreement documents. After posting the document in Authoring state, the document is visible in Adobe Sign Manage tab Draft section.

DRAFT is temporary or a primitive stage of the final intended resource which can be updated in steps to create the final resource and is not visible in Adobe Sign Manage tab Draft section. Using Draft state, Participant set info is not required and it can be later assigned while making PUT /agreements/ agreementId  to complete this draft. This step can be iterated number of times until you have all the required data to create the agreement.

IN_PROCESS changes the agreement status to Out for Signature and is visible in Adobe Sign Manage tab Out for Signature section.

Additional information

For more information, refer to REST v6 documentation:

https://secure.echosign.com/public/docs/restapi/v6

Adobe, Inc.

Get help faster and easier

New user?