Power Forms

Updates an existing PowerForm

PUT
/v2.1/accounts/{accountId}/powerforms/{powerFormId}

This method updates an existing PowerForm.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

powerFormId*string

The ID of the PowerForm.

Request Body

application/json

Information about any PowerForms that are included in the envelope.

Information about any PowerForms that are included in the envelope.

createdBy?string

The ID of the user who created the PowerForm.

createdDateTime?string

The UTC DateTime when the item was created.

emailBody?string

The body of the email message sent to the recipients.

Maximum length: 10000 characters.

emailSubject?string

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.

envelopes?array<>
errorDetails?

This object describes errors that occur. It is only valid for responses and ignored in requests.

instructions?string

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.

isActive?string

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.

lastUsed?string

The UTC DateTime when the PowerForm was last used.

limitUseInterval?string

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

limitUseIntervalEnabled?string

When true, the limitUseInterval is enabled.

limitUseIntervalUnits?string

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.

maxUseEnabled?string

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

name?string

The name of the PowerForm.

powerFormId?string

The ID of the PowerForm.

powerFormUrl?string

The URL for the PowerForm.

recipients?array<>

An array of recipient objects that provides details about the recipients of the envelope.

senderName?string

The sender's name.

senderUserId?string

The ID of the sender.

signingMode?string

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.

templateId?string

The ID of the template used to create the PowerForm.

templateName?string

The name of the template used to create the PowerForm.

timesUsed?string

The number of times the PowerForm has been used.

uri?string

The URI for the PowerForm.

usesRemaining?string

The number of times the PowerForm can still be used.

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/powerforms/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "createdBy": "string",  "createdDateTime": "string",  "emailBody": "string",  "emailSubject": "string",  "envelopes": [    {}  ],  "errorDetails": {    "errorCode": "string",    "message": "string"  },  "instructions": "string",  "isActive": "string",  "lastUsed": "string",  "limitUseInterval": "string",  "limitUseIntervalEnabled": "string",  "limitUseIntervalUnits": "string",  "maxUseEnabled": "string",  "name": "string",  "powerFormId": "string",  "powerFormUrl": "string",  "recipients": [    {      "accessCode": "string",      "accessCodeLocked": "string",      "accessCodeRequired": "string",      "email": "string",      "emailLocked": "string",      "idCheckConfigurationName": "string",      "idCheckRequired": "string",      "name": "string",      "recipientType": "string",      "roleName": "string",      "routingOrder": "string",      "templateRequiresIdLookup": "string",      "userNameLocked": "string"    }  ],  "senderName": "string",  "senderUserId": "string",  "signingMode": "string",  "templateId": "string",  "templateName": "string",  "timesUsed": "string",  "uri": "string",  "usesRemaining": "string"}