---
title: "Invite to sign actions"
url: "https://docs.signnow.com/docs/power-automate-signnow-invite-actions"
type: "page"
section: "Integrations"
slug: "power-automate-signnow-invite-actions"
---
# Invite to sign actions
# Invite to sign
Send a document or document group for signature to multiple recipients in a role-based order.
## Invite to sign a document
This action creates and sends a field invite for a document to be signed.
### Input parameters
| Parameter | Description |
| :--- | :--- |
| **Id (required)** | Document ID. |
| **Signers** | List of document signers. |
| **Email** | Recipient email address. |
| **Role (required)** | Recipient role name. e.g. Signer 1, Signer 2 |
| **Order (required)** | Order of signing. The signing order defines the sequence in which recipients must sign or fill a document. Once all recipients in an order step complete signing, the document proceeds to the next order step (e.g., 2, 3). Multiple recipients can share the same signing order. |
| **Viewers** | List of document viewers. |
| **Email (required)** | Viewer email address. |
| **Role (required)** | Viewer role name. |
| **Order (required)** | The order of receiving the review request. |
| **Approvers** | List of document approvers. |
| **Email (required)** | Approver email address. |
| **Role (required)** | Approver role name. |
| **Order (required)** | The order of receiving the approval request. |
### Advanced parameters
| Parameter | Description |
| :--- | :--- |
| **Email group** | A group of users that should receive the invite. When one of the users signs the document, it is considered completed. Must be used with the `email groups` advanced parameter. Required if `Email` or `Phone Invite` is not added, but cannot be used at the same time with either of these parameters. |
| **Phone invite** | Recipient phone number. Required for **Invite via SMS**. |
| **Signers advanced** | Signer advanced properties. |
| **Role (required)** | Recipient role name, used for mapping advanced parameters. |
| **Prefill signature name** | Pre-filled text in the signature field, available for editing by signer. |
| **Required preset signature name** | Pre-filled text for the signature field, locked for editing by the recipient. Cannot be used with `Prefill signature name` or `Require new signature`. |
| **Require new signature** | Defines whether the signer can use a saved signature. False – signer can use a saved signature; True – signer must create a new signature. |
| **Allow forwarding** | Defines whether the recipient can forward the invite to another email address. `true`: recipient can forward the invite; `false`: recipient cannot forward the invite.
**How it looks in the UI**: |
| **Allow decline by signature** | Defines whether to show the Decline to Sign option on signature fields. True – show the decline option; false – hide the decline option.
**How it looks in the UI**: |
| **Send reminder in X days** | X days after the invite, a recipient gets a reminder email (from 1 to 179 days). Must be less than `Days Until Expiration`. |
| **Send reminder in X days before expiration** | X days before expiration, a recipient gets a reminder email (from 1 to 179 days). Must be less than `Days until expiration`. |
| **Send reminder every X days** | A recipient gets a reminder email each x days after the invite is sent (from 1 to 7 days). |
| **Days until expiration** | In X days, the invite expires (from 3 to 180 days). |
| **Authentication type** | Authentication type used for recipient authentication during the signing session. Allowed values: `Password`, `Phone call`, and `Sms`.
**Example of password authentication**: |
| **Authentication password** | Password set for the signer authentication. Required for the `Password` authentication type. |
| **Authentication phone** | Phone number used to authenticate the signer. Required for the `Phone call` and `Sms` authentication type.
Example: +1XXXXXXXXX. |
| **Authentication sms message** | Custom sms message sent to the signer, containing the {password} placeholder. Used with the `Sms` authentication type. Without this parameter, the signer receives a default sms with an autogenerated password (unlock code) - `SignNow document invite unlock code: 123456`.
Example: Enter the password {password} to unlock your document. |
| **Subject** | Custom email subject for the recipient. |
| **Message** | Custom email message for the recipient. |
| **Redirect uri** | When all the requested fields are completed and signed, the signer is redirected to this URI. |
| **Redirect target** | Determines whether to open the redirect URI in a new tab in the browser or in the same tab after the signing session. Possible values: `In the new tab`– opens the link in a new tab,`In the same tab`- opens the link in the same tab. |
| **Decline redirect uri** | The link that opens after the document has been declined by the recipient. |
| **Close redirect uri** | The link that opens when the recipient clicks Save Progress and Finish Later during a signing session or Close in view mode. |
| **Is finish redirect canceled** | Specifies whether the completion redirect setting is canceled for the organization. True – the redirect is canceled; False – the redirect remains active. |
| **Is close redirect canceled** | Specifies whether the save progress redirect setting is canceled for the organization. True – the redirect is canceled; False – the redirect remains active. |
| **Is decline redirect canceled** | Specifies whether the decline redirect setting is canceled for the organization. True – the redirect is canceled; False – the redirect remains active. |
| **Language** | Specifies the language of the signing session and notification emails for the signer. Possible values: En for English, Es for Spanish, and Fr for French. If not set, the language is determined by the language of your SignNow account. |
| **Viewers advanced** | Viewer advanced properties. |
| **Role (required)** | Viewer role name. Used for mapping advanced parameters. |
| **Subject** | Custom email subject for the viewer. |
| **Message** | Custom email message for the viewer. |
| **Approver advanced** | Approver advanced properties. |
| **Role (required)** | Approver role name. Used for mapping advanced parameters. |
| **Days until expiration** | Number of days before the invite expires |
| **Message** | Custom email message for the approver. |
| **Subject** | Custom email subject for the approver. |
| **Authentication type** | Authentication type used for recipient authentication during the signing session. Allowed values: `Password`, `Phone call`, and `Sms`. |
| **Authentication password** | Password set for the signer authentication. Required for the `Password` authentication type. |
| **Authentication phone** | Phone number used to authenticate the signer. Required for the `Phone call` and `Sms` authentication type.
Example: +1XXXXXXXXX. |
| **Authentication sms message** | Custom sms message sent to the signer, containing the {password} placeholder. Used with the `Sms` authentication type. Without this parameter, the signer receives a default sms with an autogenerated password (unlock code) - `SignNow document invite unlock code: 123456`.
Example: Enter the password {password} to unlock your document. |
| **Redirect uri** | The URL that opens after the approver approves the document |
| **Redirect target** | Determines whether to open the redirect URI in a new tab in the browser or in the same tab after the signing session. Possible values:`In the new tab`– opens the link in a new tab, `In the same tab`- opens the link in the same tab |
| **From** | Sender email address. Only the email associated with your SignNow account (login email) can be used. If left blank, it is set automatically. |
| **Email groups** | Email groups. |
| **Id** | ID of an email group. A unique 40-character identifier that must be created beforehand. |
| **Name** | A name of the group. Use it in the **Signers** > **Email Group field**. |
| **Emails** | List of email addresses |
| **Email** | Email address that should receive an invite. |
| **CC** | CC recipient emails. |
| **Email** | Email address that should receive an invite. |
| **CC step** | CC steps. |
| **Name** | Name of the step. |
| **Email** | CC recipient email address. |
| **Step** | The order of sending, starting from `1`. |
| **Subject** | Email subject for all recipients. |
| **Message** | Email message for all recipients. |
| **CC subject** | CC email subject for all CC recipients. |
| **CC message** | CC email message for all CC recipients. |
| **QES signature** | Type of QES. Possible values: `Eideasy`, `Nom151`. Used to request QES signatures from signers. All signers in the invite must use the same signature type. To create an invite with QES, the user must belong to an organization with QES enabled. |
### Result example
### Output parameters
The output of this action returns the status of the document invite.
| Parameter | Description |
| :--- | :--- |
| **Status** | The document invite status.|
## Replace recipients in document invite
This action replaces recipients in the document invite based on their roles. It also allows updating invite settings such as authentication type, expiration days, and other advanced parameters for each role.
### Input parameters
| Parameter | Description |
| :--- | :--- |
| **Id (required)** | Document ID. |
| **Role (required)** | Role name of the recipient to be replaced. |
| **New email (required)** | New recipient email. |
### Advanced parameters
| Parameter | Description |
| :--- | :--- |
| **Role (required)** | Role name that requires additional invite parameters. |
| **Days until expiration** | In how many days the invite expires. 30 days max. |
| **Allow decline by signature** | Defines whether to show the **Decline to Sign** option on signature fields. True - show the decline option; False - hide the decline option. |
| **Reminder** | In how many days to send a reminder to the recipient. 30 days max. |
| **Authentication type** | Authentication type used for recipient authentication during the signing session. Allowed values: `Password`, `Phone call`, and `Sms`. |
| **Authentication password** | Password set for the signer authentication. Required for the `Password` authentication type. |
| **Authentication phone** | Phone number used to authenticate the signer. Required for the `Phone call` and `Sms` authentication type.
Example: +1XXXXXXXXX. |
| **Authentication sms message** | Custom sms message sent to the signer, containing the {password} placeholder. Used with the `Sms` authentication type. Without this parameter, the signer receives a default sms with an autogenerated password (unlock code) - `SignNow document invite unlock code: 123456`.
Example: Enter the password {password} to unlock your document. |
### Result example
### Output parameters
The output of the action produces an array of replacements. Each array contains these parameters:
| Parameter | Description |
| :--- | :--- |
| **New invite id** | The new document field invite ID. |
| **Role** | Role name of the recipient that was replaced. |
| **New email** | New recipient email. |
## Get document invite status
This action retrieves information about a document invite, including the status of each step and action.
### Input parameters
| Parameter | Description |
| :--- | :--- |
| **Id (required)** | Document ID. |
### Output parameters
The output of this action provides information about the document invite status, including signing steps and recipient details such as email, role, order, action type, invite ID, and status.
| Parameter | Description |
| :--- | :--- |
| **Is document declined** | Indicates whether the document was declined by the signer or approver. Returns `true` if declined, `false` otherwise. |
| **Steps** | List of signing steps with recipient information. |
| **Signing order** | Order of signing. |
| **Signer email** | Recipient email address. |
| **Role name** | Recipient role name. |
| **Action type** | The action required from the recipient in the document. Possible values: `Sign`, `View`, `Approve`, or `FreeFormSign`. |
| **Invite id** | Document invite ID. |
| **Status** | Signing status. Possible values: `created`, `pending`, `fulfilled`, `canceled`, `skipped`. |
| **Declined** | Returns `true` if the recipient of this step declined the document. |
| **Decline reason** | Message provided by the recipient when declining the document. |
| **Created** | Date when the step was created. |
| **Updated** | Date when the step status was last updated. |
---
## Invite to sign a document group
This action creates an invite for signing a document group. You can configure a multistep workflow, where different recipients act on the document group at different stages.
### Input parameters
| Parameter | Description |
| :--- | :--- |
| **Id (required)** | Document group ID. |
| **Invite steps** | An array of steps for the document group invite. Each step contains the signing order, invite email, role name, document, and action for that document. |
| **Order (required)** | Order of signing step: 1 - the recipient(s) sign the document group first, then the document group is sent to 2,3 etc. Several recipients can hold the same order of signing. |
| **Email** | Recipient email address. |
| **Role name (required)** | Recipient role name in the document (can be used to identify fields in the document assigned to this particular recipient). |
| **Action (required)** | Allowed action with a document. Possible values: `View`, `Sign`, `Approve`. |
| **Document id (required)** | ID of the document on which actions are required from this recipient. |
### Advanced parameters
| Parameter | Description |
| :--- | :--- |
| **Email group** | A contact group of recipients. |
| **Advanced** | Advanced properties of the document group invite step. |
| **Required preset signature name** | Pre-filled text for the signature field, locked for editing by the recipient. |
| **Allow forwarding** | Defines whether the recipient can forward the invite to another email address. `true`: recipient can forward the invite; `false`: recipient cannot forward the invite.
**How it looks in the UI**: |
| **Allow decline by signature** | Defines whether to show the Decline to Sign option on signature fields. True - show the decline option; False - hide the decline option.
**How it looks in the UI:** |
| **Authentication type** | Authentication type used for recipient authentication during the signing session. Allowed values: `Password`, `Phone call`, and `Sms`.
**Example of password authentication:** |
| **Authentication password** | Password set for the signer authentication. Required for the `Password` authentication type. |
| **Authentication phone** | Phone number used to authenticate the signer. Required for the `Phone call` and `Sms` authentication type.
Example: +1XXXXXXXXX. |
| **Authentication message** | Custom sms message sent to the signer, containing the {password} placeholder. Used with the `Sms` authentication type. Without this parameter, the signer receives a default sms with an autogenerated password (unlock code) - `SignNow document invite unlock code: 123456`. |
| **Payment request** | Object that contains details about the payment request. |
| **Merchant id** | The ID of the merchant account added to your organization (workspace). |
| **Currency** | The payment currency requested. |
| **Amount** | The payment amount requested. |
| **Redirect** | Object that contains details about the redirect url properties. |
| **Redirect Uri** | When all the requested fields are completed and signed, the signer is redirected to this URI. |
| **Redirect target** | Determines whether to open the redirect URI in a new tab in the browser or in the same tab after the signing session. Possible values: `In the new tab`– opens the link in a new tab,`In the same tab`- opens the link in the same tab. |
| **Decline redirect uri** | The link that opens after the document has been declined by the recipient. |
| **Close redirect uri** | The link that opens when a signer clicks Save Progress and Finish Later during a signing session or Close in view mode. |
| **Is finish redirect canceled** | Specifies whether the completion redirect setting is canceled for the organization. True – the redirect is canceled; False – the redirect remains active. |
| **Is close redirect canceled** | Specifies whether the save progress redirect setting is canceled for the organization. True – the redirect is canceled; False – the redirect remains active. |
| **Is decline redirect canceled** | Specifies whether the decline redirect setting is canceled for the organization. True – the redirect is canceled; False – the redirect remains active. |
| **Language** | Specifies the language of the signing session and notification emails for the signer. Possible values: `En` for English, `Es` for Spanish, and `Fr` for French. If not set, the language is determined by the language of your SignNow account. |
| **Email** | Objects that define custom email subject, email message, expiration and reminder settings for each recipient within a step. |
| **Order (required)** | Order of signing step: 1 - the recipient(s) sign the document group first, then the document group is sent to 2,3 etc. Several recipients can hold the same order of signing. |
| **Email (required)** | Recipient's email address. |
| **Email group** | A contact group of recipients. |
| **Subject** | Custom email subject for the recipient. |
| **Message** | Custom email message for the recipient. |
| **Days until expiration** | In x days, the invite expires (from 3 to 180 days). |
| **Send reminder in X days** | X days after the invite, a recipient gets a reminder email (from 1 to 179 days). Must be less than `Days until expiration`. |
| **Send reminder in X days before expiration** | X days before expiration, a recipient gets a reminder email (from 1 to 179 days). Must be less than `Days until expiration`. |
| **Send reminder every X days** | A recipient gets a reminder email each x days after the invite is sent (from 1 to 7 days). |
| **Email groups** | Defines a signing group. Required if at least one step contains a signing group (email_group). You can use both an existing email group or create your own. |
| **Id** | ID of an email group. A unique 40-character identifier that must be created beforehand. |
| **Name** | A name of the group. Use it in the **Invite Steps** > **Email Group**. |
| **Emails** | List of recipient email addresses. |
| **Email** | Email address that should receive an invite. |
| **Completion emails** | List of recipients who will receive completion emails. |
| **Email** | Email address of the recipient who will receive the completion email. |
| **Disable document attachment** | Whether to disable sending document attachments with the completion email. Possible values: False - enable document attachment, True - disable document attachment. |
| **Subject** | Custom subject for the completion email. |
| **Message** | Custom message for the completion email. |
| **Sign as merged** | If true, allows API user to send an invite which opens as merged document group in a single document. |
| **Client timestamp** | The timestamp of the document group invite. |
| **Email** | Email address that should receive an invite |
| **QES signature** | Type of QES. Possible values: `Eideasy`, `Nom151`. Used to request QES signatures from signers. All signers in the invite must use the same signature type. To create an invite with QES, the user must belong to an organization with QES enabled. |
### Result example
### Output parameters
The output of this action produces the document group invite ID.
| Parameter | Description |
| :--- | :--- |
| **Id** | Document group invite ID. |
| **Pending invite link** | Pending invite link. |
## Replace recipients in document group invite
This action replaces recipients in a document group invite by its invite ID. You can also set an invite expiration, reminders, reassign permissions, and decline options for each document.
### Input parameters
| Parameter | Description |
| :--- | :--- |
| **Id (required)** | Document group ID. |
| **Invite id (required)** | Document group invite ID. |
| **Step id** | ID of the invite step from the document group invite. |
| **Recipient to update** | Email of the recipient to replace. |
| **New recipient** | Email of the new recipient. |
### Advanced parameters
| Parameter | Description |
| :--- | :--- |
| **Expiration days** | In how many days the invite expires; 30 days max. |
| **Reminder** | In how many days to send a reminder to the signer; 30 days max. |
| **Invite action attributes** | Advanced parameters. |
| **Document Id (required)** | Document ID from document group. |
| **Allow forwarding** | Defines whether the recipient can forward the invite to another email address. `true`: recipient can forward the invite; `false`: recipient cannot forward the invite. |
| **Allow decline by signature** | Defines whether to show the Decline to Sign option on signature fields. True: show the decline option; False: hide the decline option. |
### Result example
### Output parameters
The output of this action retrieves the status of recipient replacement.
| Parameter | Description |
| :--- | :--- |
| **Status** | Status of recipients replacement. |
## Get document group invite status
This action retrieves information about a document group invite, including the status of each step and action.
### Input parameters
| Parameter | Description |
| :--- | :--- |
| **Id (required)** | Document group ID. |
### Output parameters
The output of this action provides information about the document group invite status, including signing steps and recipient details such as email, role, order, action type on a specific document, invite ID, and status.
| Parameter | Description |
| :--- | :--- |
| **Document group invite ID** | Invite ID of the document group. |
| **Status** | Document group signing status. Possible values: `created`, `pending`, `fulfilled`, `canceled`. |
| **Owner email** | Email address of the document group owner. |
| **Is document declined** | Returns `true` if any document in the group is declined by a signer or approver; otherwise, returns `false`. |
| **Steps** | List of invite steps. |
| **Step id** | Step ID from the document group invite. |
| **Signing order** | Order of signing. |
| **Document id** | Document ID. |
| **Document name** | Document name. |
| **Signer email** | Recipient email address. |
| **Role name** | Recipient role name. |
| **Action type** | The action required from the recipient in the document. Possible values: `Sign`, `View`, `Approve`, or `FreeFormSign`. |
| **Invite id** | ID of the invite step. |
| **Status** | The signing status of the step. |
| **Declined** | True if the recipient in this step declined the document. |
| **Decline reason** | Message provided by the recipient when declining the document. |
| **Created** | Date when the step was created. |
| **Updated** | Date when the step status was updated. |
---
*Full page: https://docs.signnow.com/docs/power-automate-signnow-invite-actions*