Skip to navigation
Web Forms API 101

API and UI functionality

View as Markdown

The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact Docusign Support or your account manager to find out whether the Web Forms API is available for your production account plan.

In the current release, web form configurations can be created only with the Web Forms builder UI in the eSignature web application. For creating and managing web form instances, you must use the Web Forms API.

This table lists key Web Forms features and indicates which are supported in the Web Forms API and which are supported in the Web Forms builder.

FeatureSupported in Web Forms APISupported in Web Forms builderNotes
Create, copy, modify, activate, or delete a web form configurationNoYes. See Process to Build a Web Form and related topics.The ability to download a web form configuration, upload it to create a new configuration, and activate configurations will be supported in a future Web Forms API release.
Create a web form instance that is secure and unique to a user sessionYesNoAlthough the Web Forms builder enables you to get a web form URL to send to users, this URL is publicly accessible and not unique. See Web form instance URLs for details about security features available when using the API.
Programmatically prefill web form instance dataYesNoPrefilling via the Web Forms builder requires you to construct a URL with query parameters.
Monitor web form instance statusYesNo
Programmatically retrieve data submitted in a web form instanceYesNoThe Web Forms builder CSV download feature can be used to download user-entered data manually. This data is also available in the Web Forms Data Report.
Email a remote web form instance to usersYesNoThe same web form configuration can be used to create both embedded and remote web form instances. However, individual web form instances support either embedded or remote delivery, but not both.

Next steps