module:api/PowerFormsApi

new module:api/PowerFormsApi(apiClient)

Source:

api/PowerFormsApi.js, line 41

Constructs a new PowerFormsApi.

Parameters:

Name	Type	Description
`apiClient`	module:ApiClient	Optional API client implementation to use, default to `module:ApiClient#instance` if unspecified.

Methods

createPowerForm(accountId, optsOrCallback, callback)

Source:

api/PowerFormsApi.js, line 110

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.

Parameters:

Name Type Description

accountId

String

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

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`powerForm`	module:model/PowerForm

callback

module:api/PowerFormsApi~createPowerFormCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/PowerForm

deletePowerForm(accountId, powerFormId, callback)

Source:

api/PowerFormsApi.js, line 169

Delete a PowerForm.
This method deletes a PowerForm.

Parameters:

Name	Type	Description
`accountId`	String	The external account number (int) or account ID Guid.
`powerFormId`	String
`callback`	module:api/PowerFormsApi~deletePowerFormCallback	The callback function, accepting three arguments: error, data, response

deletePowerForms(accountId, optsOrCallback, callback)

Source:

api/PowerFormsApi.js, line 229

Deletes one or more PowerForms
This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the powerFormId.

Parameters:

Name Type Description

accountId

String

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

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`powerFormsRequest`	module:model/PowerFormsRequest

callback

module:api/PowerFormsApi~deletePowerFormsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/PowerFormsResponse

getPowerForm(accountId, powerFormId, callback)

Source:

api/PowerFormsApi.js, line 289

Returns a single PowerForm.
This method returns detailed information about a specific PowerForm.

Parameters:

Name	Type	Description
`accountId`	String	The external account number (int) or account ID Guid.
`powerFormId`	String
`callback`	module:api/PowerFormsApi~getPowerFormCallback	The callback function, accepting three arguments: error, data, response data is of type: `module:model/PowerForm`

getPowerFormData(accountId, powerFormId, optsOrCallback, callback)

Source:

api/PowerFormsApi.js, line 361

Returns the form data associated with the usage of a PowerForm.
This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm.

You specify the format in which you want to retrieve the data in the Accept header. This header accepts the following values:

application/json: JSON format
application/xml: XML format
text/csv: Comma-separated value (CSV) format
Note:* Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.

Parameters:

Name Type Description

accountId

String

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

powerFormId String

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`dataLayout`	String
`fromDate`	String
`toDate`	String

callback

module:api/PowerFormsApi~getPowerFormDataCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/PowerFormsFormDataResponse

listPowerForms(accountId, optsOrCallback, callback)

Source:

api/PowerFormsApi.js, line 498

Returns the list of PowerForms available to the user.
This method returns a list of PowerForms that are available to the user.

Parameters:

Name Type Description

accountId

String

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

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`fromDate`	String
`order`	String
`orderBy`	String
`searchFields`	String
`searchText`	String
`toDate`	String

callback

module:api/PowerFormsApi~listPowerFormsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/PowerFormsResponse

listPowerFormSenders(accountId, optsOrCallback, callback)

Source:

api/PowerFormsApi.js, line 431

Returns the list of PowerForms available to the user.
This method returns a list of users who have sent PowerForms.

Parameters:

Name Type Description

accountId

String

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

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`startPosition`	String

callback

module:api/PowerFormsApi~listPowerFormSendersCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/PowerFormSendersResponse

updatePowerForm(accountId, powerFormId, optsOrCallback, callback)

Source:

api/PowerFormsApi.js, line 566

Creates a new PowerForm.
This method updates an existing PowerForm.

Parameters:

Name Type Description

accountId

String

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

powerFormId String

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`powerForm`	module:model/PowerForm

callback

module:api/PowerFormsApi~updatePowerFormCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/PowerForm

Type Definitions

createPowerFormCallback(error, data, If)

Source:

api/PowerFormsApi.js, line 54

(Optional) Callback function to receive the result of the createPowerForm operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/PowerForm	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deletePowerFormCallback(error, data, If)

Source:

api/PowerFormsApi.js, line 154

(Optional) Callback function to receive the result of the deletePowerForm operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`		This operation does not return a value.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deletePowerFormsCallback(error, data, If)

Source:

api/PowerFormsApi.js, line 212

(Optional) Callback function to receive the result of the deletePowerForms operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/PowerFormsResponse	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getPowerFormCallback(error, data, If)

Source:

api/PowerFormsApi.js, line 273

(Optional) Callback function to receive the result of the getPowerForm operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/PowerForm	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getPowerFormDataCallback(error, data, If)

Source:

api/PowerFormsApi.js, line 332

(Optional) Callback function to receive the result of the getPowerFormData operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/PowerFormsFormDataResponse	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listPowerFormsCallback(error, data, If)

Source:

api/PowerFormsApi.js, line 476

(Optional) Callback function to receive the result of the listPowerForms operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/PowerFormsResponse	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listPowerFormSendersCallback(error, data, If)

Source:

api/PowerFormsApi.js, line 414

(Optional) Callback function to receive the result of the listPowerFormSenders operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/PowerFormSendersResponse	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updatePowerFormCallback(error, data, If)

Source:

api/PowerFormsApi.js, line 548

(Optional) Callback function to receive the result of the updatePowerForm operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/PowerForm	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.