---
canonical_url: "https://docs.composio.dev/toolkits/sign_now"
markdown_url: "https://docs.composio.dev/toolkits/sign_now.md"
product: "platform"
version: null
last_updated: null
---

# SignNow

Create, send, sign, and manage electronic documents, templates, signing workflows, teams, and organizations with SignNow.

- **Category:** signatures
- **Auth:** OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 333
- **Triggers:** 0
- **Slug:** `SIGN_NOW`
- **Version:** 00000000_00

## Tools

### ACCEPT INVITE TO ORGANIZATION

**Slug:** `SIGN_NOW_ACCEPT_INVITE_TO_ORGANIZATION`

Accept a pending organization invitation for the specified organization and member.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the organization the member is invited to. |
| `user_id` | string | Yes | ID of the invited member. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ACTIVATE DEACTIVATE ALLOWED TEAM ADMINS

**Slug:** `SIGN_NOW_ACTIVATE_DEACTIVATE_ALLOWED_TEAM_ADMINS`

Activate or deactivate one allowed team admin in an organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Allowed team admin status update. |
| `org_id` | string | Yes | ID of the organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ACTIVATE EVENT SUBSCRIPTION

**Slug:** `SIGN_NOW_ACTIVATE_EVENT_SUBSCRIPTION`

Set an existing event subscription active by its 40-character subscription ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscription_id` | string | Yes | ID of the subscription; documented format is 40 lowercase letters or digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ADD AND CHANGE LOGO FROM URL

**Slug:** `SIGN_NOW_ADD_AND_CHANGE_LOGO_FROM_URL`

Add or replace a brand logo using an image URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented logo URL request body. |
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ADD AND EDIT EMAIL GENERAL BRANDING

**Slug:** `SIGN_NOW_ADD_AND_EDIT_EMAIL_GENERAL_BRANDING`

Add or update general branding used for all email types on a brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented general email branding settings. |
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ADD CONTACT TO GROUP

**Slug:** `SIGN_NOW_ADD_CONTACT_TO_GROUP`

Add an existing CRM contact to a specific contact group without creating either resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | ID of the contact group. |
| `contact_id` | string | Yes | ID of the contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ADD CUSTOM HISTORY EVENT

**Slug:** `SIGN_NOW_ADD_CUSTOM_HISTORY_EVENT`

Add a custom document-history event that may remain in SignNow audit history after the document is deleted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented custom history event JSON body. |
| `document_id` | string | Yes | The documented document ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ADD DOCUMENT METADATA

**Slug:** `SIGN_NOW_ADD_DOCUMENT_METADATA`

Attach the supplied metadata fields to one existing document.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `document_id` | string | Yes | ID of the document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ADD MEMBERS

**Slug:** `SIGN_NOW_ADD_MEMBERS`

Invite a user by email to join a SignNow organization as a member.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented member invitation payload. |
| `org_id` | string | Yes | ID of the requested organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Metadata to Document Group

**Slug:** `SIGN_NOW_ADD_METADATA_TO_DOCUMENT_GROUP`

Add documented metadata fields to a document group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The officially documented document-group metadata body. |
| `document_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ADD MODERATOR OR ADMIN

**Slug:** `SIGN_NOW_ADD_MODERATOR_OR_ADMIN`

Invite a user by email to join a SignNow organization as an admin or moderator.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented admin invitation payload. |
| `org_id` | string | Yes | ID of the requested organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Organization Members Batch

**Slug:** `SIGN_NOW_ADD_ORGANIZATION_MEMBERS_BATCH`

Invite organization members sequentially through SignNow's singular official endpoint. This operation is not atomic: successful invitations are not rolled back, and the response reports success or error for every email.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | Yes | 1-100 member emails to invite sequentially. This batch is not atomic; each item receives an independent result. |
| `org_id` | string | Yes | Organization to invite members to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ADD SMART FIELDS TO TEMPLATE

**Slug:** `SIGN_NOW_ADD_SMART_FIELDS_TO_TEMPLATE`

Create smart fields on an existing template from a documented smart-field payload.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented smart-field request body. |
| `template_id` | string | Yes | ID of the template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ADD TEMPLATE TO DOCUMENT GROUP TEMPLATE

**Slug:** `SIGN_NOW_ADD_TEMPLATE_TO_DOCUMENT_GROUP_TEMPLATE`

Attach a template described in the request body to an existing document group template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `doc_group_template_id` | string | Yes | ID of the document group template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assign Brand to Entity

**Slug:** `SIGN_NOW_ASSIGN_BRAND_TO_ENTITY`

Assign a brand to an application, document, document group, or organization using the entity's current endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand to assign. |
| `target_id` | string | Yes | ID of the entity receiving the brand. |
| `target_type` | string ("application" | "document" | "document_group" | "organization") | Yes | Type of SignNow entity that will receive the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assign Legacy Brand

**Slug:** `SIGN_NOW_ASSIGN_LEGACY_BRAND`

Deprecated: assign a brand through the generic assignment route. Use ASSIGN_BRAND_TO_ENTITY for current application, document, document-group, and organization assignments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented brand assignment payload. |
| `brand_id` | string | Yes | The documented brand id path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Document Field Invite

**Slug:** `SIGN_NOW_CANCEL_DOCUMENT_FIELD_INVITE`

Cancel the outstanding field invite for a document and record the cancellation reason.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `document_id` | string | Yes | ID of the requested document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CANCEL DOCUMENT GROUP INVITE

**Slug:** `SIGN_NOW_CANCEL_DOCUMENT_GROUP_INVITE`

Irreversibly cancel one invite identified within a specific document group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invite_id` | string | Yes | The documented document group invite ID path parameter. |
| `document_group_id` | string | Yes | The documented document group ID path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CANCEL FREEFORM INVITE

**Slug:** `SIGN_NOW_CANCEL_FREEFORM_INVITE`

Cancel a document FreeForm invite with an optional reason.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented FreeForm invite cancellation payload. |
| `invite_id` | string | Yes | ID of the invite or signature request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CANCEL INVITE FOR ONE SIGNER

**Slug:** `SIGN_NOW_CANCEL_INVITE_FOR_ONE_SIGNER`

Cancel a document-group FreeForm invite for one signer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented cancellation payload for one signer. |
| `user_id` | string | Yes | ID of the signer. |
| `document_group_id` | string | Yes | ID of the document group. |
| `dg_freeform_invite_id` | string | Yes | ID of the document-group FreeForm invite. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CANCEL INVITES FOR ALL SIGNERS

**Slug:** `SIGN_NOW_CANCEL_INVITES_FOR_ALL_SIGNERS`

Cancel a document-group FreeForm invite for every signer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented cancellation payload for all signers. |
| `document_group_id` | string | Yes | ID of the document group. |
| `dg_freeform_invite_id` | string | Yes | ID of the document-group FreeForm invite. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CANCEL SCHEDULED INVITE

**Slug:** `SIGN_NOW_CANCEL_SCHEDULED_INVITE`

Delete the active scheduled invite for a document or document group before it is sent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target_id` | string | Yes | ID of the document or document group whose active scheduled invite is cancelled. |
| `target_type` | string ("document" | "document_group") | Yes | Type of SignNow resource whose active scheduled invite is cancelled. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CHANGE TEAM PRIMARY ADMIN

**Slug:** `SIGN_NOW_CHANGE_TEAM_PRIMARY_ADMIN`

Transfer a team's primary administrator role to an existing member by user ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | ID of the team whose ownership to transfer. |
| `user_id` | string | Yes | ID of the team member who will become primary admin. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CONNECT ORGANIZATION MERCHANT ACCOUNT

**Slug:** `SIGN_NOW_CONNECT_ORGANIZATION_MERCHANT_ACCOUNT`

Connect a SignNow organization to a Stripe or Stripe Connect merchant account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented merchant-account connection settings. |
| `org_id` | string | Yes | ID of the organization to connect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CONNECT PERSONAL MERCHANT ACCOUNT

**Slug:** `SIGN_NOW_CONNECT_PERSONAL_MERCHANT_ACCOUNT`

Connect the current SignNow user to a Stripe or Stripe Connect merchant account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented personal merchant-account connection settings. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Correct Document Group Invite

**Slug:** `SIGN_NOW_CORRECT_DOCUMENT_GROUP_INVITE`

Start and complete correction of a pending document-group invite through the required SignNow routes. The calls are not atomic. If completion fails after correction mode starts, retry with correction_started=true to run only the completion step.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dg_id` | string | Yes | ID of the document group. |
| `correction` | object | Yes | Corrected invite configuration sent to complete correction mode. |
| `dg_invite_id` | string | Yes | ID of the document-group invite to correct. |
| `correction_started` | boolean | No | Set true only when a prior call already started correction mode and failed during completion; this resumes at the completion step. |
| `start_client_timestamp` | integer | No | Unix timestamp sent when correction mode is initiated; required unless correction_started is true. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE AND EDIT EDITOR BRAND RESOURCE

**Slug:** `SIGN_NOW_CREATE_AND_EDIT_EDITOR_BRAND_RESOURCE`

Create or replace the editor-specific settings for an existing brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE AND EDIT GENERAL BRAND RESOURCE

**Slug:** `SIGN_NOW_CREATE_AND_EDIT_GENERAL_BRAND_RESOURCE`

Create or replace the general settings for an existing brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE API EVENT SUBSCRIPTION

**Slug:** `SIGN_NOW_CREATE_API_EVENT_SUBSCRIPTION`

Deprecated: create a Webhooks 1.0 callback event subscription through POST /api/v2/events. Migrate to POST /v2/event-subscriptions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | One of the two officially documented request variants. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE BRAND

**Slug:** `SIGN_NOW_CREATE_BRAND`

Create a brand from the supplied documented branding settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE BRAND FROM TEMPLATE FILE

**Slug:** `SIGN_NOW_CREATE_BRAND_FROM_TEMPLATE_FILE`

Create a brand by uploading a JSON branding template file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | JSON branding template file to upload to SignNow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE CONTACT GROUP

**Slug:** `SIGN_NOW_CREATE_CONTACT_GROUP`

Create a CRM contact group from the supplied group settings; contacts are added separately.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented contact group creation payload. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE CRM CONTACT

**Slug:** `SIGN_NOW_CREATE_CRM_CONTACT`

Create one CRM contact from the supplied contact payload.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented CRM contact payload. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE DOCUMENT EMBEDDED EDITOR LINK

**Slug:** `SIGN_NOW_CREATE_DOCUMENT_EMBEDDED_EDITOR_LINK`

Generate a link that embeds the SignNow document editor. The document must not be sent, signed, deleted, or archived.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Officially documented settings for the document embedded editor link. |
| `document_id` | string | Yes | ID of the document to open in the embedded editor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE DOCUMENT EMBEDDED INVITE

**Slug:** `SIGN_NOW_CREATE_DOCUMENT_EMBEDDED_INVITE`

Create an embedded signing invite for a document, including signer and optional approver settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented document embedded-invite schema. |
| `document_id` | string | Yes | Document ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE DOCUMENT EMBEDDED INVITE LINK

**Slug:** `SIGN_NOW_CREATE_DOCUMENT_EMBEDDED_INVITE_LINK`

Generate a signing link for an existing document embedded invite.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented document embedded-invite link schema. |
| `document_id` | string | Yes | Document ID. |
| `embedded_invite_id` | string | Yes | ID of the document embedded invite. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE DOCUMENT EMBEDDED SENDING LINK

**Slug:** `SIGN_NOW_CREATE_DOCUMENT_EMBEDDED_SENDING_LINK`

Return a 15-45 minute embedded URL that opens a document editor or Send Invite page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Settings for the embedded document sending link. |
| `document_id` | string | Yes | ID of the requested document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE DOCUMENT EMBEDDED VIEW LINK

**Slug:** `SIGN_NOW_CREATE_DOCUMENT_EMBEDDED_VIEW_LINK`

Create a reusable embedded-view link for a document so it can be reviewed and downloaded without signing in.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented settings for the document embedded-view link. |
| `document_id` | string | Yes | Document ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Document From Template

**Slug:** `SIGN_NOW_CREATE_DOCUMENT_FROM_TEMPLATE`

Generate a signable document copy from a SignNow template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The documented document-copy payload. |
| `template_id` | string | Yes | ID of the source template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Document Group

**Slug:** `SIGN_NOW_CREATE_DOCUMENT_GROUP`

Create a document group from owned documents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The officially documented document-group creation body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE DOCUMENT GROUP EMBEDDED EDITOR LINK

**Slug:** `SIGN_NOW_CREATE_DOCUMENT_GROUP_EMBEDDED_EDITOR_LINK`

Generate a link that embeds the SignNow editor for a document group. The group must not be sent, signed, deleted, or archived.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Officially documented settings for the document group embedded editor link. |
| `document_group_id` | string | Yes | Document group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE DOCUMENT GROUP EMBEDDED INVITE

**Slug:** `SIGN_NOW_CREATE_DOCUMENT_GROUP_EMBEDDED_INVITE`

Create ordered embedded signing or approval invites for documents in a document group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented document-group embedded-invite schema. |
| `document_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE DOCUMENT GROUP EMBEDDED INVITE LINK

**Slug:** `SIGN_NOW_CREATE_DOCUMENT_GROUP_EMBEDDED_INVITE_LINK`

Generate a signing link for one recipient of a document-group embedded invite.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented document-group embedded-invite link schema. |
| `document_group_id` | string | Yes | Document group ID. |
| `embedded_invite_id` | string | Yes | ID of the embedded document-group invite. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE DOCUMENT GROUP EMBEDDED SENDING LINK

**Slug:** `SIGN_NOW_CREATE_DOCUMENT_GROUP_EMBEDDED_SENDING_LINK`

Return embedded URLs that open a document group's Add Documents, editor, or Send Invite page for 15-45 minutes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Settings for the embedded document-group sending link. |
| `document_group_id` | string | Yes | ID of the requested document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE DOCUMENT GROUP EMBEDDED VIEW LINK

**Slug:** `SIGN_NOW_CREATE_DOCUMENT_GROUP_EMBEDDED_VIEW_LINK`

Create a reusable embedded-view link for a document group so its documents can be reviewed and downloaded without signing in.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented settings for the document-group embedded-view link. |
| `document_group_id` | string | Yes | Document group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE DOCUMENT GROUP FROM TEMPLATE

**Slug:** `SIGN_NOW_CREATE_DOCUMENT_GROUP_FROM_TEMPLATE`

Instantiate a new document group from a document group template's unique ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `unique_id` | string | Yes | Document group template unique ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE DOCUMENT GROUP TEMPLATE

**Slug:** `SIGN_NOW_CREATE_DOCUMENT_GROUP_TEMPLATE`

Create a reusable document group template from the supplied configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Document Signing Link

**Slug:** `SIGN_NOW_CREATE_DOCUMENT_SIGNING_LINK`

Create a document signing link and QR code, optionally adding documented smart-field values to its redirect URI.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | One of the officially documented signing-link request body variants. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE EMAIL BRAND RESOURCE

**Slug:** `SIGN_NOW_CREATE_EMAIL_BRAND_RESOURCE`

Deprecated: create or update the combined legacy email brand resource. Migrate to the current typed email-general, email-logo, and email-invite resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented legacy email brand resource payload. |
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE EMAIL FOOTER

**Slug:** `SIGN_NOW_CREATE_EMAIL_FOOTER`

Deprecated: create the organization's legacy email footer. Migrate email customization to the current organization brand email resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `footer` | string | Yes | Email footer text added to messages sent on behalf of the organization. |
| `org_id` | string | Yes | ID of the organization where the email footer is set. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE EMAIL LOGO BRAND RESOURCE

**Slug:** `SIGN_NOW_CREATE_EMAIL_LOGO_BRAND_RESOURCE`

Create or replace a brand's email logo from an uploaded image file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `logo` | object | Yes | Image file for the email logo; SignNow accepts BMP, SVG, GIF, JPEG, or PNG up to 2 MB. |
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE EVENT SUBSCRIPTION

**Slug:** `SIGN_NOW_CREATE_EVENT_SUBSCRIPTION`

Create a legacy event subscription from the supplied event and callback settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented event-subscription request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE FOLDER

**Slug:** `SIGN_NOW_CREATE_FOLDER`

Create a folder under an existing SignNow folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The documented folder creation body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE FREEFORM INVITE

**Slug:** `SIGN_NOW_CREATE_FREEFORM_INVITE`

Create and send a FreeForm invite for a document group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented document-group FreeForm invite payload. |
| `document_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE GROUP TEMPLATE FROM DOCUMENT GROUP

**Slug:** `SIGN_NOW_CREATE_GROUP_TEMPLATE_FROM_DOCUMENT_GROUP`

Create a reusable template from one existing document group and the supplied template settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `doc_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE LEGACY EVENT SUBSCRIPTION

**Slug:** `SIGN_NOW_CREATE_LEGACY_EVENT_SUBSCRIPTION`

Deprecated: create a Webhooks 1.0 subscription. Migrate to the current POST /v2/event-subscriptions endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented legacy event subscription payload. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE LOGO BRAND RESOURCE

**Slug:** `SIGN_NOW_CREATE_LOGO_BRAND_RESOURCE`

Upload an image file as a brand's logo resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `logo` | object | Yes | Image file to use as the brand logo. |
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE ORGANIZATION

**Slug:** `SIGN_NOW_CREATE_ORGANIZATION`

Create an organization from the supplied organization settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented organization creation payload. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE ORGANIZATION BRAND

**Slug:** `SIGN_NOW_CREATE_ORGANIZATION_BRAND`

Create a brand owned by a specific organization from the supplied settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `organization_id` | string | Yes | ID of the organization. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE ORGANIZATION EDITOR BRAND RESOURCE

**Slug:** `SIGN_NOW_CREATE_ORGANIZATION_EDITOR_BRAND_RESOURCE`

Set editor-specific branding for a brand owned by a specific organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented organization editor branding settings. |
| `brand_id` | string | Yes | ID of the organization brand. |
| `organization_id` | string | Yes | ID of the organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE ORGANIZATION EMAIL BRAND RESOURCE

**Slug:** `SIGN_NOW_CREATE_ORGANIZATION_EMAIL_BRAND_RESOURCE`

Set email-specific branding for a brand owned by a specific organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented organization email branding settings. |
| `brand_id` | string | Yes | ID of the organization brand. |
| `organization_id` | string | Yes | ID of the organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE ORGANIZATION GENERAL BRAND RESOURCE

**Slug:** `SIGN_NOW_CREATE_ORGANIZATION_GENERAL_BRAND_RESOURCE`

Set general branding for a brand owned by a specific organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |
| `organization_id` | string | Yes | ID of the organization. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE ORGANIZATION LOGO BRAND RESOURCE

**Slug:** `SIGN_NOW_CREATE_ORGANIZATION_LOGO_BRAND_RESOURCE`

Create the logo resource for a brand owned by a specific organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `logo` | object | Yes | PNG, JPEG, GIF, or BMP logo image up to 2 MB. |
| `brand_id` | string | Yes | ID of the organization brand. |
| `organization_id` | string | Yes | ID of the organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE SCHEDULED INVITE

**Slug:** `SIGN_NOW_CREATE_SCHEDULED_INVITE`

Prepare a document or document-group invite for irreversible delivery at a future Unix timestamp.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Scheduled invite payload matching the officially documented schema. |
| `target_id` | string | Yes | ID of the document or document group for which the scheduled invite is created. |
| `target_type` | string ("document" | "document_group") | Yes | Type of SignNow resource for which the scheduled invite is created. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### CREATE TEAM

**Slug:** `SIGN_NOW_CREATE_TEAM`

Create a team from the supplied team settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented settings for the new team. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Template

**Slug:** `SIGN_NOW_CREATE_TEMPLATE`

Create a template by flattening an existing SignNow document.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The documented template creation payload. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DEACTIVATE EVENT SUBSCRIPTION

**Slug:** `SIGN_NOW_DEACTIVATE_EVENT_SUBSCRIPTION`

Set an existing event subscription inactive without deleting its configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscription_id` | string | Yes | ID of the subscription; documented format is 40 lowercase letters or digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DECLINE GROUP INVITE

**Slug:** `SIGN_NOW_DECLINE_GROUP_INVITE`

Decline a specific document group invite with the supplied reason and optional timestamp.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented JSON body containing the decline reason and optional timestamp. |
| `document_group_id` | string | Yes | ID of the document group. |
| `document_group_invite_id` | string | Yes | ID of the document group invite. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DECLINE INVITE TO ORGANIZATION

**Slug:** `SIGN_NOW_DECLINE_INVITE_TO_ORGANIZATION`

Decline a pending organization invitation for the specified organization and member.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the organization the member is invited to. |
| `user_id` | string | Yes | ID of the invited member. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DECLINE TO SIGN A FIELD INVITE

**Slug:** `SIGN_NOW_DECLINE_TO_SIGN_A_FIELD_INVITE`

Irreversibly decline one document field invite using its document and invite IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `document_id` | string | Yes | ID of the document. |
| `field_invite_id` | string | Yes | ID of the field invite. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE BRAND

**Slug:** `SIGN_NOW_DELETE_BRAND`

Delete one brand by its 40-character brand ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE CONTACT GROUP

**Slug:** `SIGN_NOW_DELETE_CONTACT_GROUP`

Delete one CRM contact group by ID rather than removing an individual contact from it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | ID of the contact group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE CRM CONTACT

**Slug:** `SIGN_NOW_DELETE_CRM_CONTACT`

Delete one CRM contact by ID rather than only removing it from a group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | ID of the CRM contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE DOCUMENT

**Slug:** `SIGN_NOW_DELETE_DOCUMENT`

Delete one existing document by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | The documented document id path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE DOCUMENT EMBEDDED INVITES

**Slug:** `SIGN_NOW_DELETE_DOCUMENT_EMBEDDED_INVITES`

Delete all active embedded invites for a document.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | Document ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Document Group

**Slug:** `SIGN_NOW_DELETE_DOCUMENT_GROUP`

Delete a document group without deleting its documents. Groups with an active group invite cannot be deleted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_group_id` | string | Yes | ID of the document group to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE DOCUMENT GROUP EMBEDDED INVITES

**Slug:** `SIGN_NOW_DELETE_DOCUMENT_GROUP_EMBEDDED_INVITES`

Delete all active embedded invites for a document group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE EDITOR BRAND RESOURCE

**Slug:** `SIGN_NOW_DELETE_EDITOR_BRAND_RESOURCE`

Remove the editor-specific settings from one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE EMAIL CANCELED RESOURCE

**Slug:** `SIGN_NOW_DELETE_EMAIL_CANCELED_RESOURCE`

Remove the canceled-invite email settings from one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE EMAIL COMPLETED RESOURCE

**Slug:** `SIGN_NOW_DELETE_EMAIL_COMPLETED_RESOURCE`

Remove the completed-invite email settings from one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must contain exactly 40 lowercase letters or digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE EMAIL GENERAL RESOURCE

**Slug:** `SIGN_NOW_DELETE_EMAIL_GENERAL_RESOURCE`

Remove the general email settings shared by a specific brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE EMAIL INVITE RESOURCE

**Slug:** `SIGN_NOW_DELETE_EMAIL_INVITE_RESOURCE`

Remove the invitation email settings from one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE EMAIL LOGO BRAND RESOURCE

**Slug:** `SIGN_NOW_DELETE_EMAIL_LOGO_BRAND_RESOURCE`

Remove the email logo resource from one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE EMAIL REASSIGN RESOURCE

**Slug:** `SIGN_NOW_DELETE_EMAIL_REASSIGN_RESOURCE`

Remove the reassignment email settings from one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE EMAIL REMINDER RESOURCE

**Slug:** `SIGN_NOW_DELETE_EMAIL_REMINDER_RESOURCE`

Remove the reminder email settings from one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must contain exactly 40 lowercase letters or digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE EMPTY TRASH BIN FOLDER

**Slug:** `SIGN_NOW_DELETE_EMPTY_TRASH_BIN_FOLDER`

Permanently delete every document in the connected user's Trash Bin. Deleted documents cannot be restored.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE EVENT SUBSCRIPTION

**Slug:** `SIGN_NOW_DELETE_EVENT_SUBSCRIPTION`

Delete an event subscription by ID rather than merely deactivating it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscription_id` | string | Yes | ID of the subscription; documented format is 40 lowercase letters or digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE FOLDER

**Slug:** `SIGN_NOW_DELETE_FOLDER`

Delete an existing SignNow folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_id` | string | Yes | ID of the folder to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE FREEFORM SIGNED CC EMAIL BRANDING

**Slug:** `SIGN_NOW_DELETE_FREEFORM_SIGNED_CC_EMAIL_BRANDING`

Remove the FreeForm-signed CC email settings from one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE GENERAL BRAND RESOURCE

**Slug:** `SIGN_NOW_DELETE_GENERAL_BRAND_RESOURCE`

Remove the general branding settings from one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE INVITE CC EMAIL BRANDING

**Slug:** `SIGN_NOW_DELETE_INVITE_CC_EMAIL_BRANDING`

Remove the invite CC email settings from one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must contain exactly 40 lowercase letters or digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE INVITE COMPLETED CC EMAIL BRANDING

**Slug:** `SIGN_NOW_DELETE_INVITE_COMPLETED_CC_EMAIL_BRANDING`

Remove the completed-invite CC email settings from one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Legacy Brand Resource

**Slug:** `SIGN_NOW_DELETE_LEGACY_BRAND_RESOURCE`

Deprecated: delete one general, editor, logo, or email resource from a legacy brand. Migrate to the current resource-specific delete endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. |
| `resource` | string ("general" | "editor" | "logo" | "email") | Yes | Legacy brand resource type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE LEGACY EVENT SUBSCRIPTION

**Slug:** `SIGN_NOW_DELETE_LEGACY_EVENT_SUBSCRIPTION`

Deprecated: delete a legacy Webhooks 1.0 event subscription. Migrate to DELETE /v2/event-subscriptions/{subscription_id}.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event_subscription_id` | string | Yes | The documented event subscription id path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE LOGO BRAND RESOURCE

**Slug:** `SIGN_NOW_DELETE_LOGO_BRAND_RESOURCE`

Remove the logo resource from one brand without deleting the brand itself.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE MERCHANT ACCOUNT

**Slug:** `SIGN_NOW_DELETE_MERCHANT_ACCOUNT`

Delete a merchant account connected to a SignNow organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the requested organization. |
| `merchant_account_id` | string | Yes | ID of the organization merchant account to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE ORGANIZATION

**Slug:** `SIGN_NOW_DELETE_ORGANIZATION`

Delete one organization by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the requested organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Organization Brand

**Slug:** `SIGN_NOW_DELETE_ORGANIZATION_BRAND`

Delete one brand owned by an organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |
| `organization_id` | string | Yes | ID of the organization. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE ORGANIZATION EDITOR BRAND RESOURCE

**Slug:** `SIGN_NOW_DELETE_ORGANIZATION_EDITOR_BRAND_RESOURCE`

Remove editor-specific settings from a brand owned by a specific organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the organization brand. |
| `organization_id` | string | Yes | ID of the organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE ORGANIZATION EMAIL BRAND RESOURCE

**Slug:** `SIGN_NOW_DELETE_ORGANIZATION_EMAIL_BRAND_RESOURCE`

Remove email-specific settings from a brand owned by a specific organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the organization brand. |
| `organization_id` | string | Yes | ID of the organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE ORGANIZATION GENERAL BRAND RESOURCE

**Slug:** `SIGN_NOW_DELETE_ORGANIZATION_GENERAL_BRAND_RESOURCE`

Remove general settings from a brand owned by a specific organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the organization brand. |
| `organization_id` | string | Yes | ID of the organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE ORGANIZATION LOGO

**Slug:** `SIGN_NOW_DELETE_ORGANIZATION_LOGO`

Delete the logo configured for an organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE ORGANIZATION LOGO BRAND RESOURCE

**Slug:** `SIGN_NOW_DELETE_ORGANIZATION_LOGO_BRAND_RESOURCE`

Remove the logo resource from a brand owned by a specific organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the organization brand. |
| `organization_id` | string | Yes | ID of the organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE PERSONAL MERCHANT ACCOUNT

**Slug:** `SIGN_NOW_DELETE_PERSONAL_MERCHANT_ACCOUNT`

Disconnect a merchant account from the current SignNow user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `merchant_account_id` | string | Yes | ID of the connected personal payment account to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE REASSIGN CC EMAIL BRANDING

**Slug:** `SIGN_NOW_DELETE_REASSIGN_CC_EMAIL_BRANDING`

Remove the reassignment CC email settings from one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must contain exactly 40 lowercase letters or digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE SEND INVITE BRAND RESOURCE

**Slug:** `SIGN_NOW_DELETE_SEND_INVITE_BRAND_RESOURCE`

Delete the send-invite branding resource from a brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE SMART FIELDS FROM TEMPLATE

**Slug:** `SIGN_NOW_DELETE_SMART_FIELDS_FROM_TEMPLATE`

Delete the smart fields selected in the request body from one template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented smart-field deletion body. |
| `template_id` | string | Yes | ID of the template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE STEP COMPLETED CC EMAIL BRANDING

**Slug:** `SIGN_NOW_DELETE_STEP_COMPLETED_CC_EMAIL_BRANDING`

Remove the completed-step CC email settings from one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must contain exactly 40 lowercase letters or digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE TEAM

**Slug:** `SIGN_NOW_DELETE_TEAM`

Delete team. Requires the connected user to be the primary team admin.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | ID of the team to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DELETE USER FROM TEAM

**Slug:** `SIGN_NOW_DELETE_USER_FROM_TEAM`

Remove a user from a team as the primary admin, or leave a team as that user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | ID of the team. |
| `user_id` | string | Yes | ID of the user to remove from the team. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Demote Team Admin

**Slug:** `SIGN_NOW_DEMOTE_TEAM_ADMIN`

Remove administrator permissions from one team user while retaining their team membership and shared-folder access. Sends downgrade_only=true.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | ID of the team. |
| `user_id` | string | Yes | ID of the team administrator. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DISABLE TEAM DOCUMENTS FOLDER

**Slug:** `SIGN_NOW_DISABLE_TEAM_DOCUMENTS_FOLDER`

Disable the Documents folder for one team without deleting the team.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | ID of the team whose Documents folder to disable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DOWNLOAD DOCUMENT

**Slug:** `SIGN_NOW_DOWNLOAD_DOCUMENT`

Download a document in the requested type, optionally with its history table.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("collapsed" | "zip" | "email") | Yes | Download format: collapsed PDF, ZIP with the PDF and attachments, or email ZIP with page IDs. |
| `document_id` | string | Yes | The documented document id path parameter. |
| `with_history` | boolean | No | When true, send the documented wire value 1 to include a history table in a collapsed document; false is omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DOWNLOAD DOCUMENT ATTACHMENT

**Slug:** `SIGN_NOW_DOWNLOAD_DOCUMENT_ATTACHMENT`

Download one attachment from a document using both document and attachment IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | Unique document id |
| `attachment_id` | string | Yes | unique id of the attachment. can be found in the response to `GET /document/{docuument_id}` request |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Document Group

**Slug:** `SIGN_NOW_DOWNLOAD_DOCUMENT_GROUP`

Download all documents in a document group in a documented format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The documented download format and history options. |
| `document_group_id` | string | Yes | ID of the document group to download. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Duplicate Document Group

**Slug:** `SIGN_NOW_DUPLICATE_DOCUMENT_GROUP`

Schedule creation of a named copy of a document group in any status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The officially documented document-group copy body. |
| `document_group_id` | string | Yes | ID of the document group to copy. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DUPLICATE DOCUMENT GROUP TEMPLATE

**Slug:** `SIGN_NOW_DUPLICATE_DOCUMENT_GROUP_TEMPLATE`

Create a new copy of one document group template using the supplied copy settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `doc_group_template_id` | string | Yes | ID of the document group template |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Duplicate Template

**Slug:** `SIGN_NOW_DUPLICATE_TEMPLATE`

Create a named editable copy of a template in the default or specified Templates folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The documented template duplication payload. |
| `template_id` | string | Yes | ID of the source template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ENABLE TEAM DOCUMENTS FOLDER

**Slug:** `SIGN_NOW_ENABLE_TEAM_DOCUMENTS_FOLDER`

Enable the Documents folder for one team without changing other team settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | ID of the team whose Documents folder to enable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Expire User Tokens

**Slug:** `SIGN_NOW_EXPIRE_USER_TOKENS`

Expire the connected SignNow user's full-scope tokens. Setting logout_all to 'true' expires every full-scope token, including the current token; setting it to 'false' expires all full-scope tokens except the current token.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Controls which full-scope tokens SignNow expires. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### EXPORT LAST ACTIVITY OF MEMBERS

**Slug:** `SIGN_NOW_EXPORT_LAST_ACTIVITY_OF_MEMBERS`

Request a CSV export of organization user activity; SignNow sends the file by email.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ban` | boolean | No | Filter by banned status. |
| `email` | string | No | Filter by member email. |
| `date_to` | integer | Yes | End of the export period as a Unix timestamp. |
| `date_from` | integer | Yes | Start of the export period as a Unix timestamp. |
| `sort_email` | string ("asc" | "desc") | No | Sort member email in ascending or descending order. |
| `organization_id` | string | Yes | ID of the organization. |
| `subscriptionstatus` | string | No | Filter by subscription status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### EXPORT LAST LOGINS OF MEMBERS

**Slug:** `SIGN_NOW_EXPORT_LAST_LOGINS_OF_MEMBERS`

Request a CSV export of member last-login data for a date range; SignNow sends the file by email.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date_to` | integer | Yes | End of the export period as a Unix timestamp. |
| `date_from` | integer | Yes | Start of the export period as a Unix timestamp. |
| `organization_id` | string | Yes | ID of the organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### EXPORT PAID REQUEST LOGS

**Slug:** `SIGN_NOW_EXPORT_PAID_REQUEST_LOGS`

Export filtered paid request logs as a streamed XLSX file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter_date` | string | No | Documented date-range filter expression covering at most 90 days. |
| `filter_client_id` | string | No | Documented application client ID filter expression. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Document

**Slug:** `SIGN_NOW_GENERATE_DOCUMENT`

Start asynchronous PDF document generation from either a publicly accessible DOCX template URL or an uploaded DOCX file. Returns the process ID for status checks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Variable mappings keyed by tags in the DOCX template. Values may include arrays of objects for repeating sections such as tables and lists. |
| `file` | object | No | DOCX template file containing generation tags. Required when source_type is file; the maximum size is 10 MB. |
| `docx_url` | string | No | Publicly accessible DOCX template URL. Required when source_type is url. |
| `source_type` | string ("url" | "file") | Yes | Template source: url for a public DOCX URL or file for an uploaded DOCX. |
| `single_document` | boolean | No | Whether to generate one document. When false, SignNow generates a document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET ACCESS TOKEN METADATA

**Slug:** `SIGN_NOW_GET_ACCESS_TOKEN_METADATA`

Return the current token's validity, scope, and expiry metadata for authorization troubleshooting.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET BRAND

**Slug:** `SIGN_NOW_GET_BRAND`

Return one brand's configuration by its 40-character brand ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET BRAND ASSIGNED TO ORGANIZATION

**Slug:** `SIGN_NOW_GET_BRAND_ASSIGNED_TO_ORGANIZATION`

Return the brand currently assigned to a specific organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | ID of an organization. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET BRAND OF APPLICATION

**Slug:** `SIGN_NOW_GET_BRAND_OF_APPLICATION`

Return the brand assigned to an application, optionally using its organization hierarchy.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `use_hierarchy` | string ("true" | "false") | No | Use `true` to fall back to organization branding, or `false` for only a direct application assignment. |
| `application_id` | string | Yes | ID of the application. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET BRAND OF DOCUMENT

**Slug:** `SIGN_NOW_GET_BRAND_OF_DOCUMENT`

Return the brand assigned to a document, optionally using its hierarchy.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | ID of the document. |
| `use_hierarchy` | boolean | No | When true, return parent application or organization branding if the document has no direct brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET BRAND OF DOCUMENT GROUP

**Slug:** `SIGN_NOW_GET_BRAND_OF_DOCUMENT_GROUP`

Return the brand assigned to a document group, optionally using its hierarchy.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `use_hierarchy` | string ("true" | "false") | No | Use `true` to fall back to parent application or organization branding, or `false` for only a direct assignment. |
| `document_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET BRAND TEMPLATE FILE

**Slug:** `SIGN_NOW_GET_BRAND_TEMPLATE_FILE`

Download the reusable branding template file used to create a brand from a file.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET CALLBACK DETAILS BY ID

**Slug:** `SIGN_NOW_GET_CALLBACK_DETAILS_BY_ID`

Return one callback delivery record within a specific event subscription using both IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `callback_id` | string | Yes | ID of the webhook callback. |
| `subscription_id` | string | Yes | ID of the event subscription. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET CONTACT GROUP

**Slug:** `SIGN_NOW_GET_CONTACT_GROUP`

Return one CRM contact group's details by group ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | ID of the contact group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET CRM CONTACT DETAILS

**Slug:** `SIGN_NOW_GET_CRM_CONTACT_DETAILS`

Return one CRM contact's details by contact ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | ID of the CRM contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET DECLINED FIELD INVITE

**Slug:** `SIGN_NOW_GET_DECLINED_FIELD_INVITE`

Return one declined field invite using its document and field-invite IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | ID of the document. |
| `field_invite_id` | string | Yes | ID of the field invite. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET DOCUMENT

**Slug:** `SIGN_NOW_GET_DOCUMENT`

Return one document's details, optionally including smart fields and document attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | Document ID. |
| `include_document_attributes` | string | No | If used, the response will contain document attributes. |
| `include_integration_objects` | string | No | If used, the response will contain the list of smart fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET DOCUMENT DOWNLOAD LINK

**Slug:** `SIGN_NOW_GET_DOCUMENT_DOWNLOAD_LINK`

Return a download URL for one existing document rather than downloading its bytes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | The documented document id path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document Generation Status

**Slug:** `SIGN_NOW_GET_DOCUMENT_GENERATION_STATUS`

Return the current state of a SignNow document generation process and, after completion, the generated document or document-group ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `process_id` | string | Yes | ID of the document generation process returned when generation started. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document Group

**Slug:** `SIGN_NOW_GET_DOCUMENT_GROUP`

Return a document group using the original document-group endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document Group Details

**Slug:** `SIGN_NOW_GET_DOCUMENT_GROUP_DETAILS`

Return detailed version 2 information for a document group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include_reminder` | string | No | Documented query value that requests reminder fields. |
| `document_group_id` | string | Yes | ID of the document group. |
| `include_document_group_attributes` | string | No | Documented query value that requests document-group attributes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET DOCUMENT GROUP HISTORY

**Slug:** `SIGN_NOW_GET_DOCUMENT_GROUP_HISTORY`

Return the recorded history events for one document group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET DOCUMENT GROUP INVITE

**Slug:** `SIGN_NOW_GET_DOCUMENT_GROUP_INVITE`

Return one invite within a specific document group using both IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invite_id` | string | Yes | ID of the document group invite. |
| `document_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET DOCUMENT HISTORY

**Slug:** `SIGN_NOW_GET_DOCUMENT_HISTORY`

Return the recorded history events for one document.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | The documented document ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET DOCUMENT METADATA

**Slug:** `SIGN_NOW_GET_DOCUMENT_METADATA`

Return the metadata entries attached to one document.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | ID of the document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET EDITOR BRAND RESOURCE

**Slug:** `SIGN_NOW_GET_EDITOR_BRAND_RESOURCE`

Return the editor-specific settings configured for one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET EMAIL BRAND RESOURCE

**Slug:** `SIGN_NOW_GET_EMAIL_BRAND_RESOURCE`

Deprecated: return the combined legacy email brand resource. Migrate to the current typed email-general, email-logo, and email-invite resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET EMAIL CANCELED RESOURCE

**Slug:** `SIGN_NOW_GET_EMAIL_CANCELED_RESOURCE`

Return the canceled-invite email settings configured for one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET EMAIL COMPLETED RESOURCE

**Slug:** `SIGN_NOW_GET_EMAIL_COMPLETED_RESOURCE`

Return the completed-invite email settings configured for one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must contain exactly 40 lowercase letters or digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET EMAIL FOOTER TEXT

**Slug:** `SIGN_NOW_GET_EMAIL_FOOTER_TEXT`

Deprecated: return one legacy organization email footer. Migrate email customization to the current organization brand email resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the organization the email footer is retrieved for. |
| `footer_id` | string | Yes | ID of the retrieved footer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET EMAIL GENERAL RESOURCE

**Slug:** `SIGN_NOW_GET_EMAIL_GENERAL_RESOURCE`

Return the general email settings shared by one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET EMAIL INVITE RESOURCE

**Slug:** `SIGN_NOW_GET_EMAIL_INVITE_RESOURCE`

Return the invitation email settings configured for one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET EMAIL LOGO BRAND RESOURCE

**Slug:** `SIGN_NOW_GET_EMAIL_LOGO_BRAND_RESOURCE`

Download a brand's email logo image.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET EMAIL REASSIGN RESOURCE

**Slug:** `SIGN_NOW_GET_EMAIL_REASSIGN_RESOURCE`

Return the reassignment email settings configured for one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET EMAIL REMINDER RESOURCE

**Slug:** `SIGN_NOW_GET_EMAIL_REMINDER_RESOURCE`

Return the reminder email settings configured for one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must contain exactly 40 lowercase letters or digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Event Subscription Details

**Slug:** `SIGN_NOW_GET_EVENT_SUBSCRIPTION_DETAILS`

Return the configuration and optional callback event count for one Webhooks 2.0 event subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscription_id` | string | Yes | ID of the subscription; documented format is 40 lowercase letters or digits. |
| `include_event_count` | boolean | No | When true, send the documented wire value true to include the callback event count; false is omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET FOLDER BY ID

**Slug:** `SIGN_NOW_GET_FOLDER_BY_ID`

Return one offset-based page of entities from a SignNow folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum documents in this page. |
| `order` | string ("asc" | "desc") | No | Sort order; use only with sortby. |
| `cursor` | string | No | Continuation offset returned by a previous call; omit for the first page. |
| `offset` | integer | No | Initial number of documents to skip. |
| `sortby` | string ("updated" | "created" | "document-name") | No | Document field used to sort the page. |
| `filters` | string ("signing-status" | "documents-created" | "documents-updated") | No | Document filter paired with filter_values. |
| `folder_id` | string | Yes | ID of the folder to return. |
| `entity_type` | string ("document-all" | "all" | "document" | "document-group") | No | Entity types to include. |
| `entity_labels` | string ("declined" | "undelivered") | No | Entity label used to filter results. |
| `filter_values` | string | No | Value paired with the selected document filter. |
| `only_favorites` | boolean | No | Whether to return only favorite entities. |
| `with_team_documents` | boolean | No | Whether to include Team Documents folders. |
| `include_documents_subfolders` | boolean | No | Whether to include documents from subfolders. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET FREEFORM SIGNED CC EMAIL BRANDING

**Slug:** `SIGN_NOW_GET_FREEFORM_SIGNED_CC_EMAIL_BRANDING`

Return the FreeForm-signed CC email settings configured for one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET GENERAL BRAND RESOURCE

**Slug:** `SIGN_NOW_GET_GENERAL_BRAND_RESOURCE`

Return the general branding settings configured for one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET INVITE CC EMAIL BRANDING

**Slug:** `SIGN_NOW_GET_INVITE_CC_EMAIL_BRANDING`

Return the invite CC email settings configured for one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must contain exactly 40 lowercase letters or digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET INVITE COMPLETED CC EMAIL BRANDING

**Slug:** `SIGN_NOW_GET_INVITE_COMPLETED_CC_EMAIL_BRANDING`

Return the completed-invite CC email settings configured for one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Legacy Brand Resource

**Slug:** `SIGN_NOW_GET_LEGACY_BRAND_RESOURCE`

Deprecated: return one general, editor, logo, or email resource for a legacy brand. Migrate to the current resource-specific endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. |
| `resource` | string ("general" | "editor" | "logo" | "email") | Yes | Legacy brand resource type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET LOGO BRAND RESOURCE

**Slug:** `SIGN_NOW_GET_LOGO_BRAND_RESOURCE`

Download a brand's logo image.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET MERCHANT ACCOUNT

**Slug:** `SIGN_NOW_GET_MERCHANT_ACCOUNT`

Retrieve a specific merchant account connected to a SignNow organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the requested organization. |
| `merchant_account_id` | string | Yes | ID of the organization merchant account to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET MONTHLY REQUEST TOTALS

**Slug:** `SIGN_NOW_GET_MONTHLY_REQUEST_TOTALS`

Return paid-request usage totals grouped by dynamic YYYYMM month keys.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET ORGANIZATION ACTIVITY

**Slug:** `SIGN_NOW_GET_ORGANIZATION_ACTIVITY`

Return activity for one organization, optionally limited to events after a timestamp.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the organization. |
| `date_from` | string | No | Start timestamp for the documented activity date filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Organization Brand

**Slug:** `SIGN_NOW_GET_ORGANIZATION_BRAND`

Return the name, owner type, and resources of one brand owned by an organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |
| `organization_id` | string | Yes | ID of the organization. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET ORGANIZATION EDITOR BRAND RESOURCE

**Slug:** `SIGN_NOW_GET_ORGANIZATION_EDITOR_BRAND_RESOURCE`

Return editor-specific settings for a brand owned by a specific organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the organization brand. |
| `organization_id` | string | Yes | ID of the organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET ORGANIZATION EMAIL BRAND RESOURCE

**Slug:** `SIGN_NOW_GET_ORGANIZATION_EMAIL_BRAND_RESOURCE`

Return email-specific settings for a brand owned by a specific organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the organization brand. |
| `organization_id` | string | Yes | ID of the organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET ORGANIZATION GENERAL BRAND RESOURCE

**Slug:** `SIGN_NOW_GET_ORGANIZATION_GENERAL_BRAND_RESOURCE`

Return general settings for a brand owned by a specific organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the organization brand. |
| `organization_id` | string | Yes | ID of the organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET ORGANIZATION LOGO BRAND RESOURCE

**Slug:** `SIGN_NOW_GET_ORGANIZATION_LOGO_BRAND_RESOURCE`

Return the logo resource for a brand owned by a specific organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the organization brand. |
| `organization_id` | string | Yes | ID of the organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET ORGANIZATION SETTINGS

**Slug:** `SIGN_NOW_GET_ORGANIZATION_SETTINGS`

Return the settings configured for an organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET PAID REQUEST TOTALS

**Slug:** `SIGN_NOW_GET_PAID_REQUEST_TOTALS`

Return total, used, and remaining paid-request quota.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET PERSONAL MERCHANT ACCOUNT

**Slug:** `SIGN_NOW_GET_PERSONAL_MERCHANT_ACCOUNT`

Retrieve a specific merchant account connected to the current SignNow user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `merchant_account_id` | string | Yes | ID of the connected personal payment account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET REASSIGN CC EMAIL BRANDING

**Slug:** `SIGN_NOW_GET_REASSIGN_CC_EMAIL_BRANDING`

Return the reassignment CC email settings configured for one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must contain exactly 40 lowercase letters or digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET REQUEST LOG

**Slug:** `SIGN_NOW_GET_REQUEST_LOG`

Return one API request log by its request ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `request_id` | string | Yes | Request ID returned by LIST_API_REQUEST_LOGS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET SEND INVITE BRAND RESOURCE

**Slug:** `SIGN_NOW_GET_SEND_INVITE_BRAND_RESOURCE`

Return the send-invite settings configured for one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET SMART FIELDS FROM TEMPLATE

**Slug:** `SIGN_NOW_GET_SMART_FIELDS_FROM_TEMPLATE`

Return the smart-field definitions configured on one template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | ID of the template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET STEP COMPLETED CC EMAIL BRANDING

**Slug:** `SIGN_NOW_GET_STEP_COMPLETED_CC_EMAIL_BRANDING`

Return the completed-step CC email settings configured for one brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Must contain exactly 40 lowercase letters or digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET TEAM

**Slug:** `SIGN_NOW_GET_TEAM`

Return one team's details by team ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | ID of the team to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET TEAM INVITE

**Slug:** `SIGN_NOW_GET_TEAM_INVITE`

Return one team invitation by its invitation request ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `request_id` | string | Yes | ID of the team invitation request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET USER DETAILS

**Slug:** `SIGN_NOW_GET_USER_DETAILS`

Return details for the connected SignNow user.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Role For Template

**Slug:** `SIGN_NOW_GET_USER_ROLE_FOR_TEMPLATE`

Retrieve a user's role for a specific shared template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | ID of the user whose role to retrieve. |
| `template_id` | string | Yes | ID of the shared template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GET WELCOME MESSAGE

**Slug:** `SIGN_NOW_GET_WELCOME_MESSAGE`

Return the current signing welcome message for the connected account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GRANT TEAM ADMIN PERMISSIONS

**Slug:** `SIGN_NOW_GRANT_TEAM_ADMIN_PERMISSIONS`

Promote an existing team member, selected by email, to administrator of a specific team.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented administrator promotion request. |
| `team_id` | string | Yes | ID of the team. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### IMPORT CRM CONTACTS IN BULK

**Slug:** `SIGN_NOW_IMPORT_CRM_CONTACTS_IN_BULK`

Import CRM contacts in bulk from a CSV file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | CSV file, no larger than 5 MB and 3000 data rows. |
| `duplicates` | string ("skip" | "replace") | No | How to handle contacts whose emails already exist. |
| `mapping_email` | string | Yes | CSV header containing contact email addresses. |
| `mapping_phone` | string | No | CSV header containing phone numbers. |
| `mapping_last_name` | string | No | CSV header containing last names. |
| `mapping_first_name` | string | No | CSV header containing first names. |
| `mapping_description` | string | No | CSV header containing descriptions. |
| `mapping_address_city` | string | No | CSV header containing cities. |
| `mapping_company_name` | string | No | CSV header containing company names. |
| `mapping_address_state` | string | No | CSV header containing states. |
| `mapping_address_street` | string | No | CSV header containing street addresses. |
| `mapping_address_country` | string | No | CSV header containing two-character country codes. |
| `mapping_address_zip_code` | string | No | CSV header containing postal codes. |
| `mapping_address_apartment` | string | No | CSV header containing apartments or units. |
| `mapping_company_job_title` | string | No | CSV header containing job titles. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Template From DocuSign

**Slug:** `SIGN_NOW_IMPORT_TEMPLATE_FROM_DOCUSIGN`

Import one or more DocuSign templates from an exported ZIP archive.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | DocuSign template ZIP archive containing the exported JSON template data; the archive must be no larger than 50 MB. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### INVITE USER TO TEAM

**Slug:** `SIGN_NOW_INVITE_USER_TO_TEAM`

Send team invitations to the email addresses supplied for one specific team.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented list of invitee email addresses. |
| `team_id` | string | Yes | ID of the team to invite users to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST ADMIN ORGANIZATIONS

**Slug:** `SIGN_NOW_LIST_ADMIN_ORGANIZATIONS`

List one page of organizations administered by the connected user, with status and type filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Positive page number starting from 1. |
| `cursor` | string | No | Continuation cursor from a previous page. |
| `per_page` | string | No | Positive page size from 1 to 100. |
| `filter_type` | string | No | URL-encoded member, admin, or moderator role filter. |
| `filter_status` | string | No | URL-encoded active or pending status filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Allowed Team Admins

**Slug:** `SIGN_NOW_LIST_ALLOWED_TEAM_ADMINS`

List the users permitted to administer teams in an organization, optionally filtered by email or active state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the organization. |
| `filter_active` | string | No | Filter by the documented active-state value. |
| `filters_email` | string | No | Filter by allowed team admin email. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST API REQUEST LOGS

**Slug:** `SIGN_NOW_LIST_API_REQUEST_LOGS`

Return one page of API request logs for the active application.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Page number starting from 1. |
| `cursor` | string | No | Continuation cursor returned by a previous request-log page. |
| `per_page` | string | No | Positive number of request logs to return per page. |
| `filter_uri` | string | No | Documented URI match or like filter expression. |
| `filter_code` | string | No | Documented response-code range filter expression. |
| `filter_time` | string | No | Documented request-duration filter expression. |
| `filter_error` | string | No | Documented error filter expression. |
| `sort_created` | string ("asc" | "desc") | No | Sort by creation time in ascending or descending order. |
| `filter_method` | string | No | Documented HTTP method filter expression. |
| `filter_created` | string | No | Documented creation-time range filter expression. |
| `filter_applicationid` | string | No | Documented application ID filter expression. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST BRANDS

**Slug:** `SIGN_NOW_LIST_BRANDS`

List every brand available to the connected account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST CALLBACKS

**Slug:** `SIGN_NOW_LIST_CALLBACKS`

List callback delivery records with optional event, application, status, initiator, entity, URL, and date filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort_code` | string ("asc" | "desc") | No | Sort by response code using asc or desc. |
| `sort_event` | string ("asc" | "desc") | No | Sort by event using asc or desc. |
| `filters_code` | string | No | URL-encoded response-code range filter. |
| `filters_date` | string | No | URL-encoded callback timestamp range filter. |
| `filters_event` | string | No | URL-encoded event filter. |
| `sort_end_time` | string ("asc" | "desc") | No | Sort by callback end time using asc or desc. |
| `sort_start_time` | string ("asc" | "desc") | No | Sort by callback start time using asc or desc. |
| `sort_application` | string ("asc" | "desc") | No | Sort by application using asc or desc. |
| `filters_event_type` | string | No | URL-encoded event-type filter. |
| `filters_application` | string | No | URL-encoded application filter. |
| `filters_entity_id_callback_url_initiator_id` | string | No | URL-encoded filter for entity, callback, and initiator IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST CALLBACKS BY EVENT SUBSCRIPTION

**Slug:** `SIGN_NOW_LIST_CALLBACKS_BY_EVENT_SUBSCRIPTION`

List callback delivery records for one event subscription with optional status, initiator, and date filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort_code` | string ("asc" | "desc") | No | Sort by response code using asc or desc. |
| `filters_code` | string | No | URL-encoded response-code range filter. |
| `filters_date` | string | No | URL-encoded callback timestamp range filter. |
| `sort_end_time` | string ("asc" | "desc") | No | Sort by callback end time using asc or desc. |
| `sort_start_time` | string ("asc" | "desc") | No | Sort by callback start time using asc or desc. |
| `subscription_id` | string | Yes | ID of the event subscription. |
| `filters_initiator_id` | string | No | URL-encoded initiator-ID filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST COMPLETED DOCUMENT FIELDS

**Slug:** `SIGN_NOW_LIST_COMPLETED_DOCUMENT_FIELDS`

Return field values from one completed document.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | ID of the document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST CONTACT GROUPS

**Slug:** `SIGN_NOW_LIST_CONTACT_GROUPS`

List one page of CRM contact groups, optionally filtered by group ID or name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Initial positive page number. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `per_page` | string | No | Positive page size from 1 to 100. |
| `filters_id` | string | No | Group ID filter JSON string. |
| `filters_name` | string | No | Group name filter JSON string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST CONTACT GROUPS FOR CONTACT

**Slug:** `SIGN_NOW_LIST_CONTACT_GROUPS_FOR_CONTACT`

Return contact groups containing a CRM contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Initial positive page number. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `per_page` | string | No | Positive page size from 1 to 100. |
| `contact_id` | string | Yes | ID of the CRM contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST CONTACTS FROM GROUP

**Slug:** `SIGN_NOW_LIST_CONTACTS_FROM_GROUP`

Return one page of contacts from a contact group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Page number as a positive digit string. |
| `sort` | string ("asc" | "desc") | No | Sort direction. Format: sort[last_interaction_at]="desc". |
| `cursor` | string | No | Next page returned by a previous call; omit for the first page. |
| `group_id` | string | Yes | ID of the group. |
| `per_page` | string | No | Number of contacts per page as a digit string from 1 to 100. |
| `filter_owners` | string | No | Owners filter, for example: filters=[{"owners":{"type":"IN","value":["contact_owner_id"]}}]. |
| `filters_email` | string | No | Email filter, for example: filters=[{"email":{"type":"=","value":"crm@email.com"}}]. |
| `combined_filter` | string | No | Combined interaction and company filter. |
| `filters_company` | string | No | Company filter, for example: filters=[{"company":{"type":"=","value":"Best company"}}]. |
| `filters_full_name` | string | No | Full-name filter, for example: filters=[{"full_name":{"type":"like","value":"value"}}]. |
| `filters_last_name` | string | No | Last-name filter, for example: filters=[{"last_name":{"type":"like","value":"value"}}]. |
| `filters_first_name` | string | No | First-name filter, for example: filters=[{"first_name":{"type":"like","value":"value"}}]. |
| `filters_not_company` | string | No | Company exclusion filter, for example: filters=[{"company":{"type":"!=","value":"Best company"}}]. |
| `filters_shared_with_me` | string | No | Shared-contact filter, for example: filters=[{"shared_with_me":{"type":"=","value":"true"}}]. |
| `combined_filter_with_or` | string | No | Combined OR filter for interaction and company fields. |
| `filters_interaction_after` | string | No | Interaction-after filter, for example: filters=[{"interaction":{"type":">","value":1652918152}}]. |
| `filters_interaction_before` | string | No | Interaction-before filter, for example: filters=[{"interaction":{"type":"<","value":1652918152}}]. |
| `combined_or_contact_name_filter` | string | No | Combined OR filter for email, first name, last name, and full name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST CRM CONTACTS

**Slug:** `SIGN_NOW_LIST_CRM_CONTACTS`

List one page of CRM contacts with optional owner, sharing, identity, company, and interaction filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Initial page number. |
| `sort` | string | No | Documented CRM contact sort expression. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `per_page` | integer | No | Contacts per page, from 1 to 100. |
| `filters_email` | string | No | Email filter JSON string. |
| `filters_owners` | string | No | Owners filter JSON string. |
| `filters_company` | string | No | Company filter JSON string. |
| `filters_full_name` | string | No | Full-name filter JSON string. |
| `filters_last_name` | string | No | Last-name filter JSON string. |
| `filters_first_name` | string | No | First-name filter JSON string. |
| `filters_not_company` | string | No | Company exclusion filter JSON string. |
| `filters_email_or_name` | string | No | Combined OR filter JSON string for email and contact names. |
| `filters_shared_with_me` | string | No | Shared-with-me filter JSON string. |
| `filters_combined_filter` | string | No | Combined filter JSON string. |
| `filters_interaction_after` | string | No | Interaction-after filter JSON string. |
| `filters_interaction_before` | string | No | Interaction-before filter JSON string. |
| `filters_combined_filter_with_or` | string | No | Combined OR filter JSON string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST CRM USERS

**Slug:** `SIGN_NOW_LIST_CRM_USERS`

List one page of CRM users and return a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Initial page number. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `per_page` | integer | No | Users per page, from 1 to 100. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST DOCUMENT FREE FORM INVITES

**Slug:** `SIGN_NOW_LIST_DOCUMENT_FREE_FORM_INVITES`

Retrieve one page of FreeForm invites for a document.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number to return, starting from 1. |
| `cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. |
| `filters` | string | No | JSON-encoded array of filters. |
| `per_page` | integer | No | Number of invites to return per page, from 1 to 100. |
| `document_id` | string | Yes | ID of the document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST DOCUMENT GROUP RECIPIENTS

**Slug:** `SIGN_NOW_LIST_DOCUMENT_GROUP_RECIPIENTS`

Return the recipients configured for one document group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Document Groups

**Slug:** `SIGN_NOW_LIST_DOCUMENT_GROUPS`

Return one offset/limit page of document groups owned by the user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | Yes | Page size from 1 through 50. |
| `cursor` | string | No | Next offset returned by a previous call; omit for the first page. |
| `offset` | integer | Yes | Zero-based result offset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST DOCUMENT GROUPS CREATED FROM TEMPLATE

**Slug:** `SIGN_NOW_LIST_DOCUMENT_GROUPS_CREATED_FROM_TEMPLATE`

List one page of document groups created from a specific template, with search, status, label, and sort options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number to display in the results. For example, if `page=2` and `per_page=10`, you'll get results from 11 to 20. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `sort_by` | string ("updated" | "created" | "document_group_name") | No | Sort results by the date of the last update, the creation date, or the document group name. Possible values: `updated`, `created`, and `document_group_name`. |
| `per_page` | integer | No | Number of document groups displayed per page. |
| `search_by` | string ("document-name" | "signer-email" | "inviter-email" | "document-text" | "document-id") | No | Specify where to look for the `search_key`. Possible values: `document-name`, `signer-email`, `inviter-email`, `document-text`, and `document-id`. |
| `search_key` | string | No | Search by key (word, part of word, or phrase). |
| `sort_order` | string ("asc" | "desc") | No | Sort results in descending or ascending order. Possible values: `asc`, `desc`. |
| `doc_group_template_id` | string | Yes | ID of the document group template |
| `filters_entity_labels` | string ("declined" | "undelivered") | No | Filter results by declined or undelivered document group templates. Possible values: `declined`, `undelivered`. |
| `filters_signing_status` | string ("waiting-for-me" | "waiting-for-others" | "signed" | "pending" | "has-invites" | "expired") | No | Filter results by document group template signing status. Possible values: `waiting-for-me`, `waiting-for-others`, `signed`, `pending`, `has-invites`, `expired`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Document Group Template Recipients

**Slug:** `SIGN_NOW_LIST_DOCUMENT_GROUP_TEMPLATE_RECIPIENTS`

List recipient, CC, document-role, reminder, and expiration routing settings for a document group template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `doc_group_template_id` | string | Yes | ID of the document group template |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST DOCUMENT GROUP TEMPLATE ROLES

**Slug:** `SIGN_NOW_LIST_DOCUMENT_GROUP_TEMPLATE_ROLES`

List one page of roles for a document group template and return a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number. Min: `1`. Default: `1`. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `per_page` | integer | No | Number of items per page. Min: `1`, Max: `100`. Default: `15`. |
| `document_group_template_id` | string | Yes | Document group template ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST DOCUMENT GROUP TEMPLATES

**Slug:** `SIGN_NOW_LIST_DOCUMENT_GROUP_TEMPLATES`

List document group templates using offset or continuation-cursor pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | Yes | The number of templates to get |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `offset` | string | No | The number of templates to skip from the first one. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST DOCUMENT GROUP USERS

**Slug:** `SIGN_NOW_LIST_DOCUMENT_GROUP_USERS`

List one page of users with access to a document group and return a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for the initial request (default 1). |
| `cursor` | string | No | Cursor returned by a previous call; omit for the first page. |
| `per_page` | integer | No | Number of items per page (1-100; default 15). |
| `document_group_id` | string | Yes | Document group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Documents From Template

**Slug:** `SIGN_NOW_LIST_DOCUMENTS_FROM_TEMPLATE`

Return one page of documents generated from a template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number to retrieve. |
| `cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. |
| `exclude` | string | No | Use `doc-from-dg` to exclude documents in document groups. |
| `sort_by` | string ("updated" | "created" | "document_name") | No | Field used to sort documents. |
| `per_page` | integer | No | Number of documents per page. |
| `search_by` | string ("document-name" | "signer-email" | "inviter-email" | "document-text" | "document-id") | No | Document field to search. |
| `search_key` | string | No | Keyword or phrase to search for. |
| `sort_order` | string ("asc" | "desc") | No | Sort direction. |
| `template_id` | string | Yes | ID of the template. |
| `filters_entity_labels` | string ("declinied" | "undelivered") | No | Declined or undelivered entity-label filter. |
| `filters_signing_status` | string ("waiting-for-me" | "waiting-for-others" | "signed" | "pending" | "has-invites" | "expired") | No | Signing status filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST DOCUMENT USERS

**Slug:** `SIGN_NOW_LIST_DOCUMENT_USERS`

List one page of users with access to a document and return a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for an initial direct page request. |
| `cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. |
| `per_page` | integer | No | Number of users per page (1-100; default 15). |
| `document_id` | string | Yes | Document ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST EMAIL FOOTERS

**Slug:** `SIGN_NOW_LIST_EMAIL_FOOTERS`

Deprecated: return all legacy organization email footers. Migrate email customization to the current organization brand email resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the organization where the email footer is set. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST EMAILS OF THE INVITE STEP

**Slug:** `SIGN_NOW_LIST_EMAILS_OF_THE_INVITE_STEP`

Return the email records for one step of a specific document group invite.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `step_id` | string | Yes | ID of a step in the invite. |
| `invite_id` | string | Yes | The documented invite ID path parameter. |
| `document_group_id` | string | Yes | The documented document group ID path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST EVENT SUBSCRIPTIONS

**Slug:** `SIGN_NOW_LIST_EVENT_SUBSCRIPTIONS`

List event subscriptions with event, application, callback URL, date, sort, and event-count options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Page value to retrieve. |
| `cursor` | string | No | Continuation cursor from a previous response. |
| `sort_event` | string ("asc" | "desc") | No | Sort by event name using asc or desc. |
| `filters_date` | string | No | URL-encoded timestamp range filter. |
| `sort_created` | string ("asc" | "desc") | No | Sort by creation date using asc or desc. |
| `filters_event` | string | No | URL-encoded event filter. |
| `sort_application` | string ("asc" | "desc") | No | Sort by application name using asc or desc. |
| `filters_application` | string | No | URL-encoded application filter. |
| `include_event_count` | boolean | No | Whether to include event counts; serialized as lowercase true or false. |
| `filters_entity_id_callback_url` | string | No | URL-encoded filter for entity IDs and callback URLs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST FAVORITES

**Slug:** `SIGN_NOW_LIST_FAVORITES`

Return one page of documents and document groups marked as favorites.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Page number to return as a positive digit string. Defaults to 1. |
| `cursor` | string | No | Next page returned by a previous call; omit for the first page. |
| `per_page` | string | No | Number of favorites per page as a positive digit string. Defaults to 15. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST FOLDERS

**Slug:** `SIGN_NOW_LIST_FOLDERS`

Return the connected user's root folder tree and its documents.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST FREE FORM INVITE DOCUMENTS

**Slug:** `SIGN_NOW_LIST_FREE_FORM_INVITE_DOCUMENTS`

Retrieve one page of documents for a document-group FreeForm invite.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Page number to return, represented as a string starting at 1. |
| `cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. |
| `per_page` | string | No | Number of documents to return per page, represented as a string from 1 to 100. |
| `document_group_id` | string | Yes | ID of the document group. |
| `dg_freeform_invite_id` | string | Yes | ID of the document-group FreeForm invite. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Legacy Event Subscriptions

**Slug:** `SIGN_NOW_LIST_LEGACY_EVENT_SUBSCRIPTIONS`

Deprecated: list Webhooks 1.0 event subscriptions for the connected user. Migrate to the current GET /v2/event-subscriptions endpoint.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST MEMBERS LAST LOGINS

**Slug:** `SIGN_NOW_LIST_MEMBERS_LAST_LOGINS`

Return the last-login audit records for organization members.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the organization. |
| `sort_email` | string ("asc" | "desc") | No | Sort records by email using asc or desc. |
| `sort_updated` | string ("asc" | "desc") | No | Sort records by update time using asc or desc. |
| `filters_email` | string | No | Filter records by member email. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Metadata of Document Group

**Slug:** `SIGN_NOW_LIST_METADATA_OF_DOCUMENT_GROUP`

Return the documented metadata response for a document group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST MODIFIED DOCUMENTS

**Slug:** `SIGN_NOW_LIST_MODIFIED_DOCUMENTS`

Return user documents that have been modified with fields or content.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST ORGANIZATION ADMINS

**Slug:** `SIGN_NOW_LIST_ORGANIZATION_ADMINS`

List administrators of one organization, optionally filtered by email or administrator type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the requested organization. |
| `filter_type` | string | No | URL-encoded active, pending, or declined status filter. |
| `filters_email` | string | No | URL-encoded email filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Organization Brands

**Slug:** `SIGN_NOW_LIST_ORGANIZATION_BRANDS`

List the brands owned by an organization with their configured resources and pagination metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | ID of the organization. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST ORGANIZATION MEMBERS

**Slug:** `SIGN_NOW_LIST_ORGANIZATION_MEMBERS`

List members of one organization with optional email, member-type, and email-sort controls.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the requested organization. |
| `sort_email` | string ("asc" | "desc") | No | Email sort direction, asc or desc. |
| `filter_type` | string | No | URL-encoded active, pending, or declined status filter. |
| `filters_email` | string | No | URL-encoded email filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST ORGANIZATION USER DOCUMENTS

**Slug:** `SIGN_NOW_LIST_ORGANIZATION_USER_DOCUMENTS`

Search and return one page of documents belonging to organization users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number to retrieve. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `per_page` | integer | No | Documents per page. |
| `sort_name` | string ("asc" | "desc") | No | Sort direction for document name. |
| `sort_added` | string ("asc" | "desc") | No | Sort direction for creation time. |
| `filters_name` | string | No | Documented document-name filter expression. |
| `filters_text` | string | No | Documented document-text filter expression. |
| `sort_changed` | string ("asc" | "desc") | No | Sort direction for update time. |
| `filters_owner` | string | No | Documented owner-email filter expression. |
| `org_unique_id` | string | Yes | ID of the organization. |
| `filters_signer` | string | No | Documented signer-email filter expression. |
| `filters_status` | string ("waiting_for_signing" | "signed" | "pending_payment") | No | Document status filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Paid Request Logs

**Slug:** `SIGN_NOW_LIST_PAID_REQUEST_LOGS`

List one page of paid API request charge records and return a cursor for the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Page number starting from 1. |
| `cursor` | string | No | Continuation cursor returned by a previous paid-request log page. |
| `filter_date` | string | No | Documented paid-request date range filter expression. |
| `filter_type` | string | No | Documented paid-request type filter expression. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST PENDING DOCUMENT GROUP INVITES

**Slug:** `SIGN_NOW_LIST_PENDING_DOCUMENT_GROUP_INVITES`

Return pending invite data for a specific invite within one document group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invite_id` | string | Yes | ID of the document group invite. |
| `document_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pinned Templates

**Slug:** `SIGN_NOW_LIST_PINNED_TEMPLATES`

List the templates pinned in a specific Templates folder or subfolder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_id` | string | Yes | ID of a Templates folder or subfolder. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Team Admins

**Slug:** `SIGN_NOW_LIST_TEAM_ADMINS`

List the administrators of a specific team, including its primary administrator.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | ID of the team whose admins to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST TEAM DOCUMENT GROUP TEMPLATES

**Slug:** `SIGN_NOW_LIST_TEAM_DOCUMENT_GROUP_TEMPLATES`

Deprecated: return one page of document group templates shared with a team. SignNow recommends listing the contents of the relevant team folders instead.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | Yes | Maximum templates to return, expressed as a string from `1` through `50`. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `offset` | string | No | Zero-based result offset expressed as a non-negative integer string. |
| `team_id` | string | Yes | ID of the team whose shared document group templates to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Team Members

**Slug:** `SIGN_NOW_LIST_TEAM_MEMBERS`

List the members and administrators of a specific team, optionally including declined invitations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | ID of the team whose members to return. |
| `with_declined_requests` | boolean | No | Include users who declined an invitation to join the team. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Template Recipients

**Slug:** `SIGN_NOW_LIST_TEMPLATE_RECIPIENTS`

List a template's signer, viewer, approver, and carbon-copy routing configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | Template ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST USER DOCUMENTS

**Slug:** `SIGN_NOW_LIST_USER_DOCUMENTS`

Return the connected user's documents that have not yet been modified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sortby_recently_used_order` | string ("desc" | "asc") | No | Sort templates by the date their invite was last sent. Applies to system and custom template folders. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST USERS ACTIVITY

**Slug:** `SIGN_NOW_LIST_USERS_ACTIVITY`

Return document activity statistics for users in an organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the organization. |
| `date_from` | string | No | Documented starting timestamp filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST USERS BY CONTACT

**Slug:** `SIGN_NOW_LIST_USERS_BY_CONTACT`

Return users connected to a CRM contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Initial page number. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `per_page` | string | No | Positive page size from 1 to 100. |
| `contact_id` | string | Yes | ID of the CRM contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### LIST USER TEAMS

**Slug:** `SIGN_NOW_LIST_USER_TEAMS`

List the teams associated with the connected SignNow user.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### MARK DOCUMENT AS FAVORITE

**Slug:** `SIGN_NOW_MARK_DOCUMENT_AS_FAVORITE`

Add a document in the Documents folder to the user's favorites.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | ID of the document to add to favorites (40 characters). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### MARK DOCUMENT GROUP AS FAVORITE

**Slug:** `SIGN_NOW_MARK_DOCUMENT_GROUP_AS_FAVORITE`

Add a document group in the Documents folder to the user's favorites.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_group_id` | string | Yes | ID of the document group to add to favorites. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### MERGE DOCUMENTS

**Slug:** `SIGN_NOW_MERGE_DOCUMENTS`

Create one merged document from the documents specified in the request body.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### MOVE DOCUMENT

**Slug:** `SIGN_NOW_MOVE_DOCUMENT`

Relocate one document according to the destination supplied in the move payload.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented move-document JSON body. |
| `document_id` | string | Yes | The documented document ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Move Document Group

**Slug:** `SIGN_NOW_MOVE_DOCUMENT_GROUP`

Move a document group and its eligible documents to another folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The documented destination and shared-document options. |
| `document_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### MOVE DOCUMENT GROUP TEMPLATE

**Slug:** `SIGN_NOW_MOVE_DOCUMENT_GROUP_TEMPLATE`

Relocate one document group template using the destination settings in the request body.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `doc_group_template_id` | string | Yes | ID of the document group template |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### MOVE DOCUMENTS IN BULK

**Slug:** `SIGN_NOW_MOVE_DOCUMENTS_IN_BULK`

Move a supplied array of documents into one target folder in a single request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | array | Yes | Documented array of documents to move. |
| `folder_unique_id` | string | Yes | ID of the target folder to move documents into. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Move Organization Members Batch

**Slug:** `SIGN_NOW_MOVE_ORGANIZATION_MEMBERS_BATCH`

Move organization members sequentially through SignNow's singular official endpoint. This operation is not atomic: successful moves are not rolled back, and the response reports success or error for every requested movement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `movements` | array | Yes | 1-100 user movements to execute sequentially through SignNow's singular move endpoint. This batch is not atomic; each item receives an independent result. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### PREFILL SMART FIELDS

**Slug:** `SIGN_NOW_PREFILL_SMART_FIELDS`

Prefill smart fields. Smart-field names are case-sensitive.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented smart-field prefill body. |
| `document_id` | string | Yes | ID of the document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### PREFILL TEXT FIELDS

**Slug:** `SIGN_NOW_PREFILL_TEXT_FIELDS`

Set text-field values on one existing document before it is completed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `document_id` | string | Yes | ID of the requested document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Access To Template

**Slug:** `SIGN_NOW_REMOVE_ACCESS_TO_TEMPLATE`

Revoke a user's access to a shared template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | ID of the user whose access to revoke. |
| `template_id` | string | Yes | ID of the shared template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### REMOVE ADMIN MODERATOR

**Slug:** `SIGN_NOW_REMOVE_ADMIN_MODERATOR`

Remove one administrator or moderator from a specific organization by admin ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the organization. |
| `admin_id` | string | Yes | ID of the admin or moderator to remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### REMOVE CONTACT FROM GROUP

**Slug:** `SIGN_NOW_REMOVE_CONTACT_FROM_GROUP`

Remove one CRM contact from a contact group without deleting the contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | ID of the contact group. |
| `contact_id` | string | Yes | ID of the contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### REMOVE DOCUMENT FROM FAVORITES

**Slug:** `SIGN_NOW_REMOVE_DOCUMENT_FROM_FAVORITES`

Remove a document in the Documents folder from the user's favorites.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | ID of the document to remove from favorites (40 characters). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### REMOVE DOCUMENT GROUP FROM FAVORITES

**Slug:** `SIGN_NOW_REMOVE_DOCUMENT_GROUP_FROM_FAVORITES`

Remove a document group in the Documents folder from the user's favorites.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_group_id` | string | Yes | ID of the document group to remove from favorites. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Metadata from Document Group

**Slug:** `SIGN_NOW_REMOVE_METADATA_FROM_DOCUMENT_GROUP`

Delete every metadata entry attached to one document group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Organization Members Batch

**Slug:** `SIGN_NOW_REMOVE_ORGANIZATION_MEMBERS_BATCH`

Remove organization members sequentially through SignNow's singular official endpoint. This operation is not atomic: successful removals are not rolled back, and the response reports success or error for every member ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | Organization to remove members from. |
| `user_ids` | array | Yes | 1-100 member IDs to remove sequentially. This batch is not atomic; each item receives an independent result. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Team Admin

**Slug:** `SIGN_NOW_REMOVE_TEAM_ADMIN`

Remove one administrator from the team, ending their team membership and revoking their shared-folder access. Sends downgrade_only=false.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | ID of the team. |
| `user_id` | string | Yes | ID of the team administrator. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rename Document Group

**Slug:** `SIGN_NOW_RENAME_DOCUMENT_GROUP`

Replace the name of one existing document group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The officially documented document-group rename body. |
| `document_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### RENAME FOLDER

**Slug:** `SIGN_NOW_RENAME_FOLDER`

Replace the name of one folder using its folder ID and the supplied rename payload.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The documented folder rename body. |
| `folder_id` | string | Yes | ID of the folder to rename. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### RENAME ORGANIZATION

**Slug:** `SIGN_NOW_RENAME_ORGANIZATION`

Replace the name of one organization using the supplied rename payload.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented organization rename payload. |
| `org_id` | string | Yes | ID of the requested organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### RENAME TEAM

**Slug:** `SIGN_NOW_RENAME_TEAM`

Replace the name of one team while leaving its membership unchanged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented replacement name for the team. |
| `team_id` | string | Yes | ID of the team to rename. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Signer

**Slug:** `SIGN_NOW_REPLACE_SIGNER`

Replace a field-invite signer through SignNow's required delete, replace, and send sequence. Steps run in order and are not atomic. On failure, execution stops without attempting later steps and the error identifies completed irreversible steps so callers do not repeat them blindly.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | ID of the document whose replacement field invite will be sent. |
| `replacement` | object | Yes | Replacement signer settings matching SignNow's official field-invite schema. |
| `field_invite_id` | string | Yes | ID of the existing field invite to delete before replacing its signer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### RESEND CALLBACK

**Slug:** `SIGN_NOW_RESEND_CALLBACK`

Redeliver one callback for a specific event subscription using both IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `callback_id` | string | Yes | Documented callback ID path parameter. |
| `subscription_id` | string | Yes | Documented subscription ID path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### RESEND DOCUMENT GROUP INVITE

**Slug:** `SIGN_NOW_RESEND_DOCUMENT_GROUP_INVITE`

Resend a specific document group invite using its group and invite IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `invite_id` | string | Yes | The documented invite id path parameter. |
| `document_group_id` | string | Yes | The documented document group id path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### RESEND EMAIL INVITE

**Slug:** `SIGN_NOW_RESEND_EMAIL_INVITE`

Resend the email invitation for a specific field invite request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `field_request_id` | string | Yes | ID of the field invite request whose email invitation to resend. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### RESEND FREEFORM INVITE

**Slug:** `SIGN_NOW_RESEND_FREEFORM_INVITE`

Resend a document-group FreeForm invite to one signer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | ID of the signer. |
| `document_group_id` | string | Yes | ID of the document group. |
| `freeform_invite_id` | string | Yes | ID of the document-group FreeForm invite. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### RESET WELCOME MESSAGE TO DEFAULT

**Slug:** `SIGN_NOW_RESET_WELCOME_MESSAGE_TO_DEFAULT`

Delete the custom signing welcome message so the account uses its default message.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### RESPOND TO ORGANIZATION ADMIN INVITE

**Slug:** `SIGN_NOW_RESPOND_TO_ORGANIZATION_ADMIN_INVITE`

Accept or decline an organization admin or moderator invitation according to the decision parameter.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the organization where the role is changed. |
| `user_id` | string | Yes | ID of the user whose role is changed. |
| `decision` | string ("accept" | "decline") | Yes | Accept or decline the organization admin or moderator invitation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### RESPOND TO TEAM INVITE

**Slug:** `SIGN_NOW_RESPOND_TO_TEAM_INVITE`

Accept or decline invitation to a team.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented accept-or-decline decision. |
| `request_id` | string | Yes | ID of the team invitation request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revoke Shared Contact Access

**Slug:** `SIGN_NOW_REVOKE_SHARED_CONTACT_ACCESS`

Remove one user's access to a CRM contact previously shared with that user; the contact itself is not deleted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | ID of the user whose access will be revoked. |
| `contact_id` | string | Yes | ID of the shared CRM contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### SEARCH DOCUMENTS TEMPLATES AND GROUPS

**Slug:** `SIGN_NOW_SEARCH_DOCUMENTS_TEMPLATES_AND_GROUPS`

Search for documents, templates, and document groups.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number to return, starting at 1. |
| `cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. |
| `per_page` | integer | No | Number of results per page, from 1 through 20. |
| `search_by` | string | Yes | Comma-separated fields to search: name, id, inviter-email, signer-email, or document-text. |
| `search_key` | string | Yes | Search phrase. Must be a non-empty string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Bulk Template Invite

**Slug:** `SIGN_NOW_SEND_BULK_TEMPLATE_INVITE`

Generate and invite multiple documents from one template using SignNow's documented CSV multipart workflow.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | CSV file containing every template role, signer email address, and generated document name. |
| `subject` | string | No | Custom email subject for all signers. |
| `folder_id` | string | Yes | ID of the folder in which generated documents will be stored. |
| `document_id` | string | Yes | Unique ID of the source template. |
| `email_message` | string | No | Custom email message for all signers. |
| `signature_type` | string ("eideasy" | "eideasy-pdf" | "nom151") | No | Qualified electronic signature type requested for every signer. |
| `client_timestamp` | integer | No | Client timestamp as Unix time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### SEND DOCUMENT GROUP BY EMAIL

**Slug:** `SIGN_NOW_SEND_DOCUMENT_GROUP_BY_EMAIL`

Irreversibly email a copy of one document group using the supplied delivery settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented JSON body for emailing a copy of the document group. |
| `document_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### SEND DOCUMENT GROUP INVITE

**Slug:** `SIGN_NOW_SEND_DOCUMENT_GROUP_INVITE`

Irreversibly send signing invitations for one document group using the supplied routing payload.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `document_group_id` | string | Yes | The ID of the document group |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### SEND DOCUMENT INVITE

**Slug:** `SIGN_NOW_SEND_DOCUMENT_INVITE`

Send a field, free-form, or payment-request invitation for a document using the officially documented request shape for that invitation type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Request body matching an officially documented semantic variant; do not accept fields absent from every documented schema or example. |
| `document_id` | string | Yes | ID of the document |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### SEND DOCUMENT SMS INVITE

**Slug:** `SIGN_NOW_SEND_DOCUMENT_SMS_INVITE`

Irreversibly send an SMS signing invitation for one document using the supplied invite payload.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `doc_id_for_sms` | string | Yes | Document ID used for SMS invite. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### SEND FAX

**Slug:** `SIGN_NOW_SEND_FAX`

Send the fax described in the request body; the delivery action is irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### SEND GROUP PAYMENT INVITE

**Slug:** `SIGN_NOW_SEND_GROUP_PAYMENT_INVITE`

Send a document-group invite containing fixed or calculated payment requests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Document-group invite containing fixed or calculated payment requests. |
| `group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### SEND SCHEDULED INVITE

**Slug:** `SIGN_NOW_SEND_SCHEDULED_INVITE`

Irreversibly send an existing scheduled document or document-group invite now and return its delivery result.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target_id` | string | Yes | ID of the document or document group whose scheduled invite is sent immediately. |
| `target_type` | string ("document" | "document_group") | Yes | Type of SignNow resource whose scheduled invite is sent immediately. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### SET ALLOWED TEAM ADMIN

**Slug:** `SIGN_NOW_SET_ALLOWED_TEAM_ADMIN`

Add one email address as an allowed team admin for an organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Allowed team admin to add. |
| `org_id` | string | Yes | ID of the organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### SHARE CONTACT WITH OTHER USERS

**Slug:** `SIGN_NOW_SHARE_CONTACT_WITH_OTHER_USERS`

Grant the users in the request payload access to one existing CRM contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented contact sharing payload. |
| `contact_id` | string | Yes | ID of the CRM contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### SHARE DOCUMENT

**Slug:** `SIGN_NOW_SHARE_DOCUMENT`

Grant document access according to the recipients and permissions in the sharing payload.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented document-sharing JSON body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### SHARE DOCUMENT GROUP

**Slug:** `SIGN_NOW_SHARE_DOCUMENT_GROUP`

Grant access to one document group according to the supplied sharing settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented document group sharing request body. |
| `document_group_id` | string | Yes | Document group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### SHARE DOCUMENT GROUP TEMPLATE

**Slug:** `SIGN_NOW_SHARE_DOCUMENT_GROUP_TEMPLATE`

Grant access to one document group template according to the supplied sharing settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `document_group_template_id` | string | Yes | Document group template ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### SHARE TEAM DOCUMENT GROUP TEMPLATE

**Slug:** `SIGN_NOW_SHARE_TEAM_DOCUMENT_GROUP_TEMPLATE`

Deprecated: share a document group template with a team. SignNow recommends moving the template into a team folder or subfolder instead.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | ID of the team that will receive the document group template. |
| `doc_group_id` | string | Yes | ID of the document group template to share with the team. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Share Template

**Slug:** `SIGN_NOW_SHARE_TEMPLATE`

Share a template once with another user as a sender or viewer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The documented template sharing payload. |
| `template_id` | string | Yes | ID of the template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### TERMINATE ACCESS TOKEN

**Slug:** `SIGN_NOW_TERMINATE_ACCESS_TOKEN`

Irreversibly revoke the current access token so it can no longer authorize requests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The required empty JSON object documented by SignNow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UNASSIGN BRAND

**Slug:** `SIGN_NOW_UNASSIGN_BRAND`

Deprecated: remove a brand through the generic assignment route. Migrate to DELETE /v2/applications/{application_id}/brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented brand unassignment payload. |
| `brand_id` | string | Yes | The documented brand id path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UNASSIGN BRAND FROM APPLICATION

**Slug:** `SIGN_NOW_UNASSIGN_BRAND_FROM_APPLICATION`

Remove the direct brand assignment from an application.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `application_id` | string | Yes | ID of the application. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UNASSIGN BRAND FROM DOCUMENT

**Slug:** `SIGN_NOW_UNASSIGN_BRAND_FROM_DOCUMENT`

Remove the direct brand assignment from a document.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | ID of the document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UNASSIGN BRAND FROM DOCUMENT GROUP

**Slug:** `SIGN_NOW_UNASSIGN_BRAND_FROM_DOCUMENT_GROUP`

Remove the direct brand assignment from a document group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UNASSIGN BRAND FROM ORGANIZATION

**Slug:** `SIGN_NOW_UNASSIGN_BRAND_FROM_ORGANIZATION`

Remove a brand as the default for one organization without deleting the brand itself.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `organization_id` | string | Yes | ID of an organization. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UNSHARE DOCUMENT FROM ALL USERS

**Slug:** `SIGN_NOW_UNSHARE_DOCUMENT_FROM_ALL_USERS`

Revoke every user's shared access to one document in a single operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | Document ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UNSHARE DOCUMENT FROM USER

**Slug:** `SIGN_NOW_UNSHARE_DOCUMENT_FROM_USER`

Revoke one specified user's shared access to a document.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | ID of the user to unshare. |
| `document_id` | string | Yes | Document ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UNSHARE DOCUMENT GROUP FROM ALL USERS

**Slug:** `SIGN_NOW_UNSHARE_DOCUMENT_GROUP_FROM_ALL_USERS`

Revoke every user's shared access to one document group in a single operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_group_id` | string | Yes | Document group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UNSHARE DOCUMENT GROUP FROM USER

**Slug:** `SIGN_NOW_UNSHARE_DOCUMENT_GROUP_FROM_USER`

Revoke one specified user's shared access to a document group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | ID of the user to unshare. |
| `document_group_id` | string | Yes | Document group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UNSHARE DOCUMENT GROUP TEMPLATE FROM USER

**Slug:** `SIGN_NOW_UNSHARE_DOCUMENT_GROUP_TEMPLATE_FROM_USER`

Revoke one specified user's shared access to a document group template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | ID of the user to unshare. |
| `document_group_template_id` | string | Yes | Document group template ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UNSHARE GROUP TEMPLATE FROM ALL USERS

**Slug:** `SIGN_NOW_UNSHARE_GROUP_TEMPLATE_FROM_ALL_USERS`

Revoke every user's shared access to one document group template in a single operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_group_template_id` | string | Yes | Document group template ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UNSHARE TEAM DOCUMENT GROUP TEMPLATE

**Slug:** `SIGN_NOW_UNSHARE_TEAM_DOCUMENT_GROUP_TEMPLATE`

Deprecated: remove a document group template from a team. SignNow recommends moving the template back to a personal folder instead.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | ID of the team from which to remove the document group template. |
| `doc_group_id` | string | Yes | ID of the document group template to remove from the team. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Brand

**Slug:** `SIGN_NOW_UPDATE_BRAND`

Update the name of an existing brand.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE CANCELED INVITE EMAIL BRANDING

**Slug:** `SIGN_NOW_UPDATE_CANCELED_INVITE_EMAIL_BRANDING`

Apply canceled-invite email branding to one brand; this update is marked irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Localized canceled-invite email branding. |
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE COMPLETED INVITE EMAIL BRANDING

**Slug:** `SIGN_NOW_UPDATE_COMPLETED_INVITE_EMAIL_BRANDING`

Apply completed-invite email branding to one brand; this update is marked irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented completed-invite email branding settings. |
| `brand_id` | string | Yes | ID of the brand. Must contain exactly 40 lowercase letters or digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE CONTACT GROUP

**Slug:** `SIGN_NOW_UPDATE_CONTACT_GROUP`

Update one CRM contact group's settings without changing its contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented contact group update payload. |
| `group_id` | string | Yes | ID of the contact group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE CRM CONTACT

**Slug:** `SIGN_NOW_UPDATE_CRM_CONTACT`

Update one existing CRM contact from the supplied contact payload.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented CRM contact update payload. |
| `contact_id` | string | Yes | ID of the CRM contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE DOCUMENT

**Slug:** `SIGN_NOW_UPDATE_DOCUMENT`

Update a document's documented fields, including payment-request fields when supplied.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Request body matching an officially documented semantic variant; do not accept fields absent from every documented schema or example. |
| `document_id` | string | Yes | Document ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Document Group

**Slug:** `SIGN_NOW_UPDATE_DOCUMENT_GROUP`

Reorder documents or update the completion-email action for a document group that has no pending or fulfilled signature invites.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The documented document-group order and completion-email changes. |
| `document_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE DOCUMENT GROUP INVITE

**Slug:** `SIGN_NOW_UPDATE_DOCUMENT_GROUP_INVITE`

Irreversibly update one step of a specific document group invite.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `step_id` | string | Yes | ID of the invite step to update. |
| `invite_id` | string | Yes | ID of the document group invite. |
| `document_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE DOCUMENT GROUP RECIPIENTS

**Slug:** `SIGN_NOW_UPDATE_DOCUMENT_GROUP_RECIPIENTS`

Update recipient routing for one existing document group from the supplied payload.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented recipient configuration JSON body. |
| `document_group_id` | string | Yes | ID of the document group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE DOCUMENT GROUP ROLE

**Slug:** `SIGN_NOW_UPDATE_DOCUMENT_GROUP_ROLE`

Change one user's role on a specific document group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented document group role update request body. |
| `user_id` | string | Yes | ID of the user whose role is being changed. |
| `document_group_id` | string | Yes | Document group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE DOCUMENT GROUP TEMPLATE

**Slug:** `SIGN_NOW_UPDATE_DOCUMENT_GROUP_TEMPLATE`

Update one document group template from the supplied template settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `doc_group_template_id` | string | Yes | ID of the document group template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE DOCUMENT GROUP TEMPLATE RECIPIENTS

**Slug:** `SIGN_NOW_UPDATE_DOCUMENT_GROUP_TEMPLATE_RECIPIENTS`

Update recipient routing for one document group template from the supplied payload.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `doc_group_template_id` | string | Yes | ID of the document group template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE DOCUMENT GROUP TEMPLATE ROLE

**Slug:** `SIGN_NOW_UPDATE_DOCUMENT_GROUP_TEMPLATE_ROLE`

Change one user's role on a specific document group template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `user_id` | string | Yes | ID of the user whose role is being changed. |
| `document_group_template_id` | string | Yes | Document group template ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE EMAIL FOOTER

**Slug:** `SIGN_NOW_UPDATE_EMAIL_FOOTER`

Deprecated: update one legacy organization email footer. Migrate email customization to the current organization brand email resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `active` | boolean | Yes | Whether this organization email footer is active. |
| `footer` | string | Yes | Replacement email footer text. |
| `org_id` | string | Yes | ID of the organization the email footer is retrieved for. |
| `footer_id` | string | Yes | ID of the retrieved footer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE EMAIL LOGO FROM URL

**Slug:** `SIGN_NOW_UPDATE_EMAIL_LOGO_FROM_URL`

Add and update email logo for brand from URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented email logo URL payload. |
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE EVENT SUBSCRIPTION

**Slug:** `SIGN_NOW_UPDATE_EVENT_SUBSCRIPTION`

Update one existing legacy event subscription's callback or event settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented event-subscription update body. |
| `subscription_id` | string | Yes | ID of the subscription; documented format is 40 lowercase letters or digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE FREEFORM SIGNED CC EMAIL BRANDING

**Slug:** `SIGN_NOW_UPDATE_FREEFORM_SIGNED_CC_EMAIL_BRANDING`

Apply FreeForm-signed CC email branding to one brand; this update is marked irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE INVITE CC EMAIL BRANDING

**Slug:** `SIGN_NOW_UPDATE_INVITE_CC_EMAIL_BRANDING`

Apply invite CC email branding to one brand; this update is marked irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented invite CC email branding settings. |
| `brand_id` | string | Yes | ID of the brand. Must contain exactly 40 lowercase letters or digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE INVITE COMPLETED CC EMAIL BRANDING

**Slug:** `SIGN_NOW_UPDATE_INVITE_COMPLETED_CC_EMAIL_BRANDING`

Apply completed-invite CC email branding to one brand; this update is marked irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE INVITE EMAIL BRANDING

**Slug:** `SIGN_NOW_UPDATE_INVITE_EMAIL_BRANDING`

Apply invitation email branding to one brand; this update is marked irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Localized invite email branding. |
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE ORGANIZATION ADMIN ROLE

**Slug:** `SIGN_NOW_UPDATE_ORGANIZATION_ADMIN_ROLE`

Change one user's administrator or moderator role within a specific organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented role update payload. |
| `org_id` | string | Yes | ID of the organization where the role is changed. |
| `user_id` | string | Yes | ID of the user whose role is changed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Organization Brand

**Slug:** `SIGN_NOW_UPDATE_ORGANIZATION_BRAND`

Update the name of one brand owned by an organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |
| `organization_id` | string | Yes | ID of the organization. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE ORGANIZATION SETTINGS

**Slug:** `SIGN_NOW_UPDATE_ORGANIZATION_SETTINGS`

Update one named organization setting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented organization setting update. |
| `org_id` | string | Yes | ID of the organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE REASSIGN CC EMAIL BRANDING

**Slug:** `SIGN_NOW_UPDATE_REASSIGN_CC_EMAIL_BRANDING`

Apply reassignment CC email branding to one brand; this update is marked irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented reassign CC email branding settings. |
| `brand_id` | string | Yes | ID of the brand. Must contain exactly 40 lowercase letters or digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE REASSIGN EMAIL BRANDING

**Slug:** `SIGN_NOW_UPDATE_REASSIGN_EMAIL_BRANDING`

Apply reassignment email branding to one brand; this update is marked irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Localized reassignment email branding. |
| `brand_id` | string | Yes | ID of the brand. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE REMINDER EMAIL BRANDING

**Slug:** `SIGN_NOW_UPDATE_REMINDER_EMAIL_BRANDING`

Apply reminder email branding to one brand; this update is marked irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented reminder email branding settings. |
| `brand_id` | string | Yes | ID of the brand. Must contain exactly 40 lowercase letters or digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Role For Template

**Slug:** `SIGN_NOW_UPDATE_ROLE_FOR_TEMPLATE`

Change a user's role for a shared template as its owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The documented template-role update payload. |
| `user_id` | string | Yes | ID of the user whose role will change. |
| `template_id` | string | Yes | ID of the template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE SCHEDULED INVITE

**Slug:** `SIGN_NOW_UPDATE_SCHEDULED_INVITE`

Reschedule an active document or document-group invite to a new future Unix timestamp.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Updated scheduled timestamp. |
| `target_id` | string | Yes | ID of the document or document group whose active scheduled invite is updated. |
| `target_type` | string ("document" | "document_group") | Yes | Type of SignNow resource whose active scheduled invite is updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE SIGNING WELCOME MESSAGE

**Slug:** `SIGN_NOW_UPDATE_SIGNING_WELCOME_MESSAGE`

Replace the connected account's signing welcome message with the supplied text.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE STEP COMPLETED CC EMAIL BRANDING

**Slug:** `SIGN_NOW_UPDATE_STEP_COMPLETED_CC_EMAIL_BRANDING`

Apply completed-step CC email branding to one brand; this update is marked irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented step-completed CC email branding settings. |
| `brand_id` | string | Yes | ID of the brand. Must contain exactly 40 lowercase letters or digits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPDATE TEAM INVITE STATUS

**Slug:** `SIGN_NOW_UPDATE_TEAM_INVITE_STATUS`

Update the status of a waiting team invite.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented team invite status update. |
| `request_id` | string | Yes | ID of the invite to join the team. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Template Recipients

**Slug:** `SIGN_NOW_UPDATE_TEMPLATE_RECIPIENTS`

Update a template's signer, viewer, approver, carbon-copy, completion, and branding routing details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Documented template routing fields to replace or update. |
| `template_id` | string | Yes | Template ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Details

**Slug:** `SIGN_NOW_UPDATE_USER_DETAILS`

Update the connected SignNow user's first name, last name, or password. Changing the password requires old_password. This action does not expire tokens.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The connected user's first name, last name, or password to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPLOAD DOCUMENT

**Slug:** `SIGN_NOW_UPLOAD_DOCUMENT`

Create a document from an uploaded file, optionally detecting simple text tags.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | Document file to upload to SignNow. |
| `check_fields` | boolean | No | If true, you can upload a document with simple text tags. For more information, see [Upload document with tags](/docs/signnow/document/operations/create-a-document-fieldextract). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPLOAD DOCUMENT FROM URL

**Slug:** `SIGN_NOW_UPLOAD_DOCUMENT_FROM_URL`

Create a document by having SignNow fetch the source URL supplied in the request body.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPLOAD DOCUMENT WITH TAGS

**Slug:** `SIGN_NOW_UPLOAD_DOCUMENT_WITH_TAGS`

Create a document from a file while parsing optional complex text tags with a selected parse flow.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | Tagged document file to upload to SignNow. |
| `tags` | string | No | A JSON array of complex text tags in the document. Example: {     "tag_name": "EmployeeName",     "role": "Employee",     "label": "Your name",     "required": true,     "type": "text",     "width": 100,     "height": 20 } |
| `parse_type` | string ("tag" | "adobe" | "all" | "default") | No | Determines the parse flow for document text tags. Possible values:  `tag`, `adobe`, `all`, `default`.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPLOAD ORGANIZATION LOGO

**Slug:** `SIGN_NOW_UPLOAD_ORGANIZATION_LOGO`

Upload an image file as the organization logo.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `logo` | object | Yes | Image file to upload as the organization logo. |
| `org_id` | string | Yes | ID of the organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Document Group Signing Link

**Slug:** `SIGN_NOW_UPSERT_DOCUMENT_GROUP_SIGNING_LINK`

Create a signing link for a document group, or update its existing signing link. The authenticated user must own the document group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_group_id` | string | Yes | ID of the document group whose signing link should be created or updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### UPSERT SEND INVITE BRANDING

**Slug:** `SIGN_NOW_UPSERT_SEND_INVITE_BRANDING`

Create or replace one brand's send-invite email settings; this update is marked irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Request body matching the officially documented schema; do not accept undocumented fields. |
| `brand_id` | string | Yes | ID of the brand. Must match the pattern: [a-z0-9]{40}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |