v1

latestSwagger 2.02026-07-134146194.6 MB

PowerForms

Creates a new PowerForm

This method creates a new PowerForm.

You create a PowerForm from an existing Docusign template, based on the templateId in the request body.

PowerForms that you create from a template are referred to as web PowerForms.

Note: The Docusign Admin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a PDF PowerForm). However, PDF PowerForms are deprecated and are not supported in the API.

Note: A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm initiator.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm.

Signing modes

You can use one of the following signing modes for a PowerForm:

email

This mode verifies the recipient's identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks Begin Signing to begin the signing process. The system then sends an email message with a validation code to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document.

Alternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the activateonly flag to the PowerForm URL and set it to true by passing in the value 1. When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code.

Example: activateonly=1

direct

This mode does not require any verification. After a recipient enters their email address on the landing page and clicks Begin Signing, a new browser tab opens and the recipient can immediately begin the signing process.

Because the direct signing mode does not verify the recipient's identity by using email authentication, we strongly recommend that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the Docusign template (for example, an access code, phone authentication, or ID check).

Note: In the account settings, enablePowerFormDirect must be true to use direct as the signingMode.

Redirect URLs

You can control the URL to which signers are redirected after signing your PowerForm. However, the URL is specified elsewhere, outside of the PowerForm creation process. For details, see How do I specify a URL to redirect to when a PowerForm is completed?.

More information

For more information about creating PowerForms, see Create a PowerForm.

post/v2.1/accounts/{accountId}/powerforms

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

Request body

createdBystring

The ID of the user who created the PowerForm.

createdDateTimestring

The UTC DateTime when the item was created.

emailBodystring

The body of the email message sent to the recipients.

Maximum length: 10000 characters.

emailSubjectstring

The subject line of the email message that is sent to all recipients.

For information about adding merge field information to the email subject, see Template Email Subject Merge Fields.

Note: The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.

instructionsstring

The instructions that display on the landing page for the first recipient. These instructions are important if the recipient accesses the PowerForm by a method other than email. If instructions are entered, they display as an introduction after the recipient accesses the PowerForm. Limit: 2000 characters.

isActivestring

When true, indicates that the PowerForm is active and can be sent to recipients. This is the default value.

When false, the PowerForm cannot be emailed or accessed by a recipient, even if they arrive at the PowerForm URL.

If a recipient attempts to sign an inactive PowerForm, an error message informs the recipient that the document is not active and suggests that they contact the sender.

lastUsedstring

The UTC DateTime when the PowerForm was last used.

limitUseIntervalstring

The length of time before the same recipient can sign the same PowerForm. This property is used in combination with the limitUseIntervalUnits property.

limitUseIntervalEnabledstring

When true, the limitUseInterval is enabled.

limitUseIntervalUnitsstring

The units associated with the limitUseInterval. Valid values are:

minutes
`hours
days
weeks
months

For example, to limit a recipient to signing once per year, set the limitUseInterval to 365 and the limitUseIntervalUnits to days.

maxUseEnabledstring

When true, you can set a maximum number of uses for the PowerForm.

namestring

The name of the PowerForm.

powerFormIdstring

The ID of the PowerForm.

powerFormUrlstring

The URL for the PowerForm.

senderNamestring

The sender's name.

senderUserIdstring

The ID of the sender.

signingModestring

The signing mode to use. Valid values are:

email: Verifies the recipient's identity using email authentication before the recipient can sign a document. The recipient enters their email address and then clicks Begin Signing to begin the signing process. The system then sends an email message with a validation code for the PowerForm to the recipient. If the recipient does not provide a valid email address, they cannot open and sign the document.
direct: Does not require any verification. After a recipient enters their email address and clicks Begin Signing, a new browser tab opens and the recipient can immediately begin the signing process. Because the recipient's identity is not verified by using email authentication, we strongly recommend that you only use the direct signing mode when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the Docusign template (for example, an access code, phone authentication, or ID check).

Note: In the account settings, enablePowerFormDirect must be true to use direct as the signingMode.

templateIdstring

The ID of the template used to create the PowerForm.

templateNamestring

The name of the template used to create the PowerForm.

timesUsedstring

The number of times the PowerForm has been used.

uristring

The URI for the PowerForm.

usesRemainingstring

The number of times the PowerForm can still be used.

Response

Successful response.