Skip to content

DocuSign: Creates a new Power Form

DocuSign esignature.esignaturePowerFormsPostPowerForm: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_powerforms_postpowerform

Provider route: POST /restapi/v2.1/accounts/{accountId}/powerforms. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignaturePowerFormsPostPowerForm"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignaturePowerFormsPostPowerForm(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_power_forms_post_power_form(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
bodyModelOptionalExpand Creates a new Power Form — request body — body

Referenced models: Creates a new Power Form — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Creates a new Power Form — response body

Referenced models: Creates a new Power Form — response body

163 more schemas are linked from the tables above, on the schema pages.

Creates a new Power Form — response body
FieldTypePresenceDescription and constraints
$objectRootContains details about a PowerForm.
createdBystringOptionalThe ID of the user who created the PowerForm.
createdDateTimestringOptionalThe UTC DateTime when the item was created.
emailBodystringOptionalThe body of the email message sent to the recipients.

Maximum length: 10000 characters.
emailSubjectstringOptionalThe 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](/docs/esign-rest-api/reference/templates/templates/create/#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.
envelopesarrayOptional
envelopes[]ModelEach itemExpand Gets the status of a single envelope — response body
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
instructionsstringOptionalThe 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.
isActivestringOptionalWhen **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.
lastUsedstringOptionalThe UTC DateTime when the PowerForm was last used.
limitUseIntervalstringOptionalThe length of time before the same recipient can sign the same PowerForm. This property is used in combination with the `limitUseIntervalUnits` property.
limitUseIntervalEnabledstringOptionalWhen **true,** the `limitUseInterval` is enabled.
limitUseIntervalUnitsstringOptionalThe 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`.
maxUseEnabledstringOptionalWhen **true,** you can set a maximum number of uses for the PowerForm.
namestringOptionalThe name of the PowerForm.
powerFormIdstringOptionalThe ID of the PowerForm.
powerFormUrlstringOptionalThe URL for the PowerForm.
recipientsarrayOptionalAn array of recipient objects that provides details about the recipients of the envelope.
recipients[]ModelEach itemExpand Creates a new Power Form — response body — recipients item
senderNamestringOptionalThe sender's name.
senderUserIdstringOptionalThe ID of the sender.
signingModestringOptionalThe 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`.
templateIdstringOptionalThe ID of the template used to create the PowerForm.
templateNamestringOptionalThe name of the template used to create the PowerForm.
timesUsedstringOptionalThe number of times the PowerForm has been used.
uristringOptionalThe URI for the PowerForm.
usesRemainingstringOptionalThe number of times the PowerForm can still be used.

Referenced models: Gets the status of a single envelope — response body, Locks a template — response body — error Details, Creates a new Power Form — response body — recipients item

Creates a new Power Form — request body — body
FieldTypePresenceDescription and constraints
$objectRootContains details about a PowerForm.
createdBystringOptionalThe ID of the user who created the PowerForm.
createdDateTimestringOptionalThe UTC DateTime when the item was created.
emailBodystringOptionalThe body of the email message sent to the recipients.

Maximum length: 10000 characters.
emailSubjectstringOptionalThe 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](/docs/esign-rest-api/reference/templates/templates/create/#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.
envelopesarrayOptional
envelopes[]ModelEach itemExpand Send, void, or modify a draft envelope Purge documents from a completed envelope — request body — body
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
instructionsstringOptionalThe 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.
isActivestringOptionalWhen **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.
lastUsedstringOptionalThe UTC DateTime when the PowerForm was last used.
limitUseIntervalstringOptionalThe length of time before the same recipient can sign the same PowerForm. This property is used in combination with the `limitUseIntervalUnits` property.
limitUseIntervalEnabledstringOptionalWhen **true,** the `limitUseInterval` is enabled.
limitUseIntervalUnitsstringOptionalThe 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`.
maxUseEnabledstringOptionalWhen **true,** you can set a maximum number of uses for the PowerForm.
namestringOptionalThe name of the PowerForm.
powerFormIdstringOptionalThe ID of the PowerForm.
powerFormUrlstringOptionalThe URL for the PowerForm.
recipientsarrayOptionalAn array of recipient objects that provides details about the recipients of the envelope.
recipients[]ModelEach itemExpand Creates a new Power Form — response body — recipients item
senderNamestringOptionalThe sender's name.
senderUserIdstringOptionalThe ID of the sender.
signingModestringOptionalThe 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`.
templateIdstringOptionalThe ID of the template used to create the PowerForm.
templateNamestringOptionalThe name of the template used to create the PowerForm.
timesUsedstringOptionalThe number of times the PowerForm has been used.
uristringOptionalThe URI for the PowerForm.
usesRemainingstringOptionalThe number of times the PowerForm can still be used.

Referenced models: Locks a template — response body — error Details, Creates a new Power Form — response body — recipients item, Send, void, or modify a draft envelope Purge documents from a completed envelope — request body — body

Locks a template — response body — error Details
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.

SDK function policy ID: docusign.esignature_powerforms_postpowerform. Catalog operation: esignature:PowerForms_PostPowerForm. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.