Skip to main content
SignNow logo
  • Category: signatures
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 333
  • Triggers: 0
  • Slug: SIGN_NOW
  • Version: 20261101_00

Tools

Slug: SIGN_NOW_ACCEPT_INVITE_TO_ORGANIZATIONAccept a pending organization invitation for the specified organization and member.

Input Parameters

string
required
ID of the organization the member is invited to.
string
required
ID of the invited member.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_ACTIVATE_DEACTIVATE_ALLOWED_TEAM_ADMINSActivate or deactivate one allowed team admin in an organization.

Input Parameters

object
required
Allowed team admin status update.
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_ACTIVATE_EVENT_SUBSCRIPTIONSet an existing event subscription active by its 40-character subscription ID.

Input Parameters

string
required
ID of the subscription; documented format is 40 lowercase letters or digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_ADD_AND_CHANGE_LOGO_FROM_URLAdd or replace a brand logo using an image URL.

Input Parameters

object
required
Documented logo URL request body.
string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_ADD_AND_EDIT_EMAIL_GENERAL_BRANDINGAdd or update general branding used for all email types on a brand.

Input Parameters

object
required
Documented general email branding settings.
string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_ADD_CONTACT_TO_GROUPAdd an existing CRM contact to a specific contact group without creating either resource.

Input Parameters

string
required
ID of the contact group.
string
required
ID of the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_ADD_CUSTOM_HISTORY_EVENTAdd a custom document-history event that may remain in SignNow audit history after the document is deleted.

Input Parameters

object
required
Documented custom history event JSON body.
string
required
The documented document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_ADD_DOCUMENT_METADATAAttach metadata to one existing document using the supported key, key1, and key2 fields and a source.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_ADD_MEMBERSInvite a user by email to join a SignNow organization as a member.

Input Parameters

object
required
Documented member invitation payload.
string
required
ID of the requested organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_ADD_METADATA_TO_DOCUMENT_GROUPAdd documented metadata fields to a document group.

Input Parameters

object
required
The officially documented document-group metadata body.
string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_ADD_MODERATOR_OR_ADMINInvite a user by email to join a SignNow organization as an admin or moderator.

Input Parameters

object
required
Documented admin invitation payload.
string
required
ID of the requested organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_ADD_ORGANIZATION_MEMBERS_BATCHInvite organization members sequentially by email; successful invitations are not rolled back. Provider errors are reported per email, but an empty email can abort the batch after earlier invitations have succeeded.

Input Parameters

array
required
1-100 member emails to invite sequentially. This batch is not atomic; each item receives an independent result.
string
required
Organization to invite members to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_ADD_SMART_FIELDS_TO_TEMPLATECreate smart fields on an existing template from a documented smart-field payload.

Input Parameters

object
required
Documented smart-field request body.
string
required
ID of the template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_ADD_TEMPLATE_TO_DOCUMENT_GROUP_TEMPLATEAttach a document or template to an existing document group template, specifying exactly one source.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the document group template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_ASSIGN_BRAND_TO_ENTITYAssign a brand to an application, document, document group, or organization using the entity’s current endpoint.

Input Parameters

string
required
ID of the brand to assign.
string
required
ID of the entity receiving the brand.
string ("application" | "document" | "document_group" | "organization")
required
Type of SignNow entity that will receive the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_ASSIGN_LEGACY_BRANDDeprecated: assign a brand through the generic assignment route. Use ASSIGN_BRAND_TO_ENTITY for current application, document, document-group, and organization assignments.

Input Parameters

object
required
Documented brand assignment payload.
string
required
The documented brand id path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CANCEL_DOCUMENT_FIELD_INVITECancel the outstanding field invite for a document and record the cancellation reason.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the requested document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CANCEL_DOCUMENT_GROUP_INVITEIrreversibly cancel one invite identified within a specific document group.

Input Parameters

string
required
The documented document group invite ID path parameter.
string
required
The documented document group ID path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CANCEL_FREEFORM_INVITECancel a document FreeForm invite with an optional reason.

Input Parameters

object
required
Documented FreeForm invite cancellation payload.
string
required
ID of the invite or signature request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CANCEL_INVITE_FOR_ONE_SIGNERCancel a document-group FreeForm invite for one signer.

Input Parameters

object
required
Documented cancellation payload for one signer.
string
required
ID of the signer.
string
required
ID of the document group.
string
required
ID of the document-group FreeForm invite.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CANCEL_INVITES_FOR_ALL_SIGNERSCancel a document-group FreeForm invite for every signer.

Input Parameters

object
required
Documented cancellation payload for all signers.
string
required
ID of the document group.
string
required
ID of the document-group FreeForm invite.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CANCEL_SCHEDULED_INVITEDelete the active scheduled invite for a document or document group before it is sent.

Input Parameters

string
required
ID of the document or document group whose active scheduled invite is cancelled.
string ("document" | "document_group")
required
Type of SignNow resource whose active scheduled invite is cancelled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CHANGE_TEAM_PRIMARY_ADMINTransfer a team’s primary administrator role to an existing member by user ID.

Input Parameters

string
required
ID of the team whose ownership to transfer.
string
required
ID of the team member who will become primary admin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CONNECT_ORGANIZATION_MERCHANT_ACCOUNTConnect a SignNow organization to a Stripe or Stripe Connect merchant account.

Input Parameters

object
required
Documented merchant-account connection settings.
string
required
ID of the organization to connect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CONNECT_PERSONAL_MERCHANT_ACCOUNTConnect the current SignNow user to a Stripe or Stripe Connect merchant account.

Input Parameters

object
required
Documented personal merchant-account connection settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CORRECT_DOCUMENT_GROUP_INVITEStart 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_AND_EDIT_EDITOR_BRAND_RESOURCECreate or replace the editor-specific settings for an existing brand.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_AND_EDIT_GENERAL_BRAND_RESOURCECreate or replace the general settings for an existing brand.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_API_EVENT_SUBSCRIPTIONDeprecated: create a Webhooks 1.0 callback event subscription through POST /api/v2/events. Migrate to POST /v2/event-subscriptions.

Input Parameters

string
required
One of the two officially documented request variants.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_BRANDCreate a brand with the supplied title.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_BRAND_FROM_TEMPLATE_FILECreate a brand by uploading a JSON branding template file.

Input Parameters

object
required
JSON branding template file to upload to SignNow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_CONTACT_GROUPCreate a CRM contact group from the supplied group settings; contacts are added separately.

Input Parameters

object
required
Documented contact group creation payload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_CRM_CONTACTCreate one CRM contact from the supplied contact payload.

Input Parameters

object
required
Documented CRM contact payload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_DOCUMENT_EMBEDDED_INVITECreate an embedded signing invite for a document, including signer and optional approver settings.

Input Parameters

object
required
Request body matching the officially documented document embedded-invite schema.
string
required
Document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_DOCUMENT_FROM_TEMPLATEGenerate a signable document copy from a SignNow template.

Input Parameters

object
required
The documented document-copy payload.
string
required
ID of the source template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_DOCUMENT_GROUPCreate a document group from owned documents.

Input Parameters

object
required
The officially documented document-group creation body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_DOCUMENT_GROUP_EMBEDDED_INVITECreate ordered embedded signing or approval invites for documents in a document group.

Input Parameters

object
required
Request body matching the officially documented document-group embedded-invite schema.
string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_DOCUMENT_GROUP_FROM_TEMPLATEInstantiate a new document group from a document group template’s unique ID.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
Document group template unique ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_DOCUMENT_GROUP_TEMPLATECreate a reusable document group template from the supplied configuration.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_EMAIL_BRAND_RESOURCEDeprecated: create or update the combined legacy email brand resource. Migrate to the current typed email-general, email-logo, and email-invite resources.

Input Parameters

object
required
Documented legacy email brand resource payload.
string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_EMAIL_LOGO_BRAND_RESOURCECreate or replace a brand’s email logo from an uploaded image file.

Input Parameters

Image file for the email logo; SignNow accepts BMP, SVG, GIF, JPEG, or PNG up to 2 MB.
string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_EVENT_SUBSCRIPTIONCreate a legacy event subscription from the supplied event and callback settings.

Input Parameters

object
required
Documented event-subscription request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_FOLDERCreate a folder under an existing SignNow folder.

Input Parameters

object
required
The documented folder creation body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_FREEFORM_INVITECreate and send a FreeForm invite for a document group.

Input Parameters

object
required
Documented document-group FreeForm invite payload.
string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_GROUP_TEMPLATE_FROM_DOCUMENT_GROUPCreate a reusable template from one existing document group and the supplied template settings.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_LEGACY_EVENT_SUBSCRIPTIONDeprecated: create a Webhooks 1.0 subscription. Migrate to the current POST /v2/event-subscriptions endpoint.

Input Parameters

object
required
Documented legacy event subscription payload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_LOGO_BRAND_RESOURCEUpload an image file as a brand’s logo resource.

Input Parameters

object
required
Image file to use as the brand logo.
string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_ORGANIZATIONCreate an organization from the supplied organization settings.

Input Parameters

object
required
Documented organization creation payload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_ORGANIZATION_BRANDCreate a brand owned by a specific organization from the supplied settings.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the organization. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_ORGANIZATION_EDITOR_BRAND_RESOURCESet editor-specific branding for a brand owned by a specific organization.

Input Parameters

object
required
Documented organization editor branding settings.
string
required
ID of the organization brand.
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_ORGANIZATION_EMAIL_BRAND_RESOURCESet email-specific branding for a brand owned by a specific organization.

Input Parameters

object
required
Documented organization email branding settings.
string
required
ID of the organization brand.
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_ORGANIZATION_GENERAL_BRAND_RESOURCESet general branding for a brand owned by a specific organization.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.
string
required
ID of the organization. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_ORGANIZATION_LOGO_BRAND_RESOURCECreate the logo resource for a brand owned by a specific organization.

Input Parameters

object
required
PNG, JPEG, GIF, or BMP logo image up to 2 MB.
string
required
ID of the organization brand.
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_SCHEDULED_INVITEPrepare a document or document-group invite for irreversible delivery at a future Unix timestamp.

Input Parameters

object
required
Scheduled invite payload matching the officially documented schema.
string
required
ID of the document or document group for which the scheduled invite is created.
string ("document" | "document_group")
required
Type of SignNow resource for which the scheduled invite is created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_TEAMCreate a team from the supplied team settings.

Input Parameters

object
required
Documented settings for the new team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_CREATE_TEMPLATECreate a template by flattening an existing SignNow document.

Input Parameters

object
required
The documented template creation payload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DEACTIVATE_EVENT_SUBSCRIPTIONSet an existing event subscription inactive without deleting its configuration.

Input Parameters

string
required
ID of the subscription; documented format is 40 lowercase letters or digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DECLINE_GROUP_INVITEDecline a specific document group invite with the supplied reason and optional timestamp.

Input Parameters

object
required
Documented JSON body containing the decline reason and optional timestamp.
string
required
ID of the document group.
string
required
ID of the document group invite.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DECLINE_INVITE_TO_ORGANIZATIONDecline a pending organization invitation for the specified organization and member.

Input Parameters

string
required
ID of the organization the member is invited to.
string
required
ID of the invited member.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DECLINE_TO_SIGN_A_FIELD_INVITEIrreversibly decline one document field invite using its document and invite IDs.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the document.
string
required
ID of the field invite.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_BRANDDelete one brand by its 40-character brand ID.

Input Parameters

string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_CONTACT_GROUPDelete one CRM contact group by ID rather than removing an individual contact from it.

Input Parameters

string
required
ID of the contact group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_CRM_CONTACTDelete one CRM contact by ID rather than only removing it from a group.

Input Parameters

string
required
ID of the CRM contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_DOCUMENTDelete one existing document by ID.

Input Parameters

string
required
The documented document id path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_DOCUMENT_EMBEDDED_INVITESDelete all active embedded invites for a document.

Input Parameters

string
required
Document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_DOCUMENT_GROUPDelete a document group without deleting its documents. Groups with an active group invite cannot be deleted.

Input Parameters

string
required
ID of the document group to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_DOCUMENT_GROUP_EMBEDDED_INVITESDelete all active embedded invites for a document group.

Input Parameters

string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_EDITOR_BRAND_RESOURCERemove the editor-specific settings from one brand.

Input Parameters

string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_EMAIL_CANCELED_RESOURCERemove the canceled-invite email settings from one brand.

Input Parameters

string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_EMAIL_COMPLETED_RESOURCERemove the completed-invite email settings from one brand.

Input Parameters

string
required
ID of the brand. Must contain exactly 40 lowercase letters or digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_EMAIL_GENERAL_RESOURCERemove the general email settings shared by a specific brand.

Input Parameters

string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_EMAIL_INVITE_RESOURCERemove the invitation email settings from one brand.

Input Parameters

string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_EMAIL_LOGO_BRAND_RESOURCERemove the email logo resource from one brand.

Input Parameters

string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_EMAIL_REASSIGN_RESOURCERemove the reassignment email settings from one brand.

Input Parameters

string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_EMAIL_REMINDER_RESOURCERemove the reminder email settings from one brand.

Input Parameters

string
required
ID of the brand. Must contain exactly 40 lowercase letters or digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_EMPTY_TRASH_BIN_FOLDERPermanently delete every document in the connected user’s Trash Bin. Deleted documents cannot be restored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_EVENT_SUBSCRIPTIONDelete an event subscription by ID rather than merely deactivating it.

Input Parameters

string
required
ID of the subscription; documented format is 40 lowercase letters or digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_FOLDERDelete an existing SignNow folder.

Input Parameters

string
required
ID of the folder to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_FREEFORM_SIGNED_CC_EMAIL_BRANDINGRemove the FreeForm-signed CC email settings from one brand.

Input Parameters

string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_GENERAL_BRAND_RESOURCERemove the general branding settings from one brand.

Input Parameters

string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_INVITE_CC_EMAIL_BRANDINGRemove the invite CC email settings from one brand.

Input Parameters

string
required
ID of the brand. Must contain exactly 40 lowercase letters or digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_INVITE_COMPLETED_CC_EMAIL_BRANDINGRemove the completed-invite CC email settings from one brand.

Input Parameters

string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_LEGACY_BRAND_RESOURCEDeprecated: delete one general, editor, logo, or email resource from a legacy brand. Migrate to the current resource-specific delete endpoint.

Input Parameters

string
required
ID of the brand.
string ("general" | "editor" | "logo" | "email")
required
Legacy brand resource type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_LEGACY_EVENT_SUBSCRIPTIONDeprecated: delete a legacy Webhooks 1.0 event subscription. Migrate to DELETE /v2/event-subscriptions/{subscription_id}.

Input Parameters

string
required
The documented event subscription id path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_LOGO_BRAND_RESOURCERemove the logo resource from one brand without deleting the brand itself.

Input Parameters

string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_MERCHANT_ACCOUNTDelete a merchant account connected to a SignNow organization.

Input Parameters

string
required
ID of the requested organization.
string
required
ID of the organization merchant account to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_ORGANIZATIONDelete one organization by ID.

Input Parameters

string
required
ID of the requested organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_ORGANIZATION_BRANDDelete one brand owned by an organization.

Input Parameters

string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.
string
required
ID of the organization. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_ORGANIZATION_EDITOR_BRAND_RESOURCERemove editor-specific settings from a brand owned by a specific organization.

Input Parameters

string
required
ID of the organization brand.
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_ORGANIZATION_EMAIL_BRAND_RESOURCERemove email-specific settings from a brand owned by a specific organization.

Input Parameters

string
required
ID of the organization brand.
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_ORGANIZATION_GENERAL_BRAND_RESOURCERemove general settings from a brand owned by a specific organization.

Input Parameters

string
required
ID of the organization brand.
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_ORGANIZATION_LOGODelete the logo configured for an organization.

Input Parameters

string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_ORGANIZATION_LOGO_BRAND_RESOURCERemove the logo resource from a brand owned by a specific organization.

Input Parameters

string
required
ID of the organization brand.
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_PERSONAL_MERCHANT_ACCOUNTDisconnect a merchant account from the current SignNow user.

Input Parameters

string
required
ID of the connected personal payment account to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_REASSIGN_CC_EMAIL_BRANDINGRemove the reassignment CC email settings from one brand.

Input Parameters

string
required
ID of the brand. Must contain exactly 40 lowercase letters or digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_SEND_INVITE_BRAND_RESOURCEDelete the send-invite branding resource from a brand.

Input Parameters

string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_SMART_FIELDS_FROM_TEMPLATEDelete the smart fields selected in the request body from one template.

Input Parameters

object
required
Documented smart-field deletion body.
string
required
ID of the template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_STEP_COMPLETED_CC_EMAIL_BRANDINGRemove the completed-step CC email settings from one brand.

Input Parameters

string
required
ID of the brand. Must contain exactly 40 lowercase letters or digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_TEAMDelete team. Requires the connected user to be the primary team admin.

Input Parameters

string
required
ID of the team to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DELETE_USER_FROM_TEAMRemove a user from a team as the primary admin, or leave a team as that user.

Input Parameters

string
required
ID of the team.
string
required
ID of the user to remove from the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DEMOTE_TEAM_ADMINRemove administrator permissions from one team user while retaining their team membership and shared-folder access. Sends downgrade_only=true.

Input Parameters

string
required
ID of the team.
string
required
ID of the team administrator.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DISABLE_TEAM_DOCUMENTS_FOLDERDisable the Documents folder for one team without deleting the team.

Input Parameters

string
required
ID of the team whose Documents folder to disable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DOWNLOAD_DOCUMENTDownload a document as a collapsed PDF, a ZIP with the PDF and attachments, or an email ZIP with page IDs. A history table can optionally be included in a collapsed document.

Input Parameters

string ("collapsed" | "zip" | "email")
required
Download format: collapsed PDF, ZIP with the PDF and attachments, or email ZIP with page IDs.
string
required
The documented document id path parameter.
boolean
When true, send the documented wire value 1 to include a history table in a collapsed document; false is omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DOWNLOAD_DOCUMENT_ATTACHMENTDownload one attachment from a document using both document and attachment IDs.

Input Parameters

string
required
Unique document id
string
required
unique id of the attachment. can be found in the response to GET /document/{docuument_id} request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DOWNLOAD_DOCUMENT_GROUPDownload all documents in a document group in a documented format.

Input Parameters

object
required
The documented download format and history options.
string
required
ID of the document group to download.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DUPLICATE_DOCUMENT_GROUPSchedule creation of a named copy of a document group in any status.

Input Parameters

object
required
The officially documented document-group copy body.
string
required
ID of the document group to copy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DUPLICATE_DOCUMENT_GROUP_TEMPLATECreate a new copy of one document group template using the supplied copy settings.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the document group template

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_DUPLICATE_TEMPLATECreate a named editable copy of a template in the default or specified Templates folder.

Input Parameters

object
required
The documented template duplication payload.
string
required
ID of the source template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_ENABLE_TEAM_DOCUMENTS_FOLDEREnable the Documents folder for one team without changing other team settings.

Input Parameters

string
required
ID of the team whose Documents folder to enable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_EXPIRE_USER_TOKENSExpire 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

object
required
Controls which full-scope tokens SignNow expires.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_EXPORT_LAST_ACTIVITY_OF_MEMBERSRequest a CSV export of organization user activity; SignNow sends the file by email.

Input Parameters

boolean
Filter by banned status.
string
Filter by member email.
integer
required
End of the export period as a Unix timestamp.
integer
required
Start of the export period as a Unix timestamp.
string ("asc" | "desc")
Sort member email in ascending or descending order.
string
required
ID of the organization.
string
Filter by subscription status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_EXPORT_LAST_LOGINS_OF_MEMBERSRequest a CSV export of member last-login data for a date range; SignNow sends the file by email.

Input Parameters

integer
required
End of the export period as a Unix timestamp.
integer
required
Start of the export period as a Unix timestamp.
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_EXPORT_PAID_REQUEST_LOGSExport filtered paid request logs as a streamed XLSX file.

Input Parameters

string
Documented date-range filter expression covering at most 90 days.
string
Documented application client ID filter expression.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GENERATE_DOCUMENTStart 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_ACCESS_TOKEN_METADATAReturn the current token’s validity, scope, and expiry metadata for authorization troubleshooting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_BRANDReturn one brand’s configuration by its 40-character brand ID.

Input Parameters

string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_BRAND_ASSIGNED_TO_ORGANIZATIONReturn the brand currently assigned to a specific organization.

Input Parameters

string
required
ID of an organization. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_BRAND_OF_APPLICATIONReturn the brand assigned to an application, optionally using its organization hierarchy.

Input Parameters

string ("true" | "false")
Use true to fall back to organization branding, or false for only a direct application assignment.
string
required
ID of the application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_BRAND_OF_DOCUMENTReturn the brand assigned to a document, optionally using its hierarchy.

Input Parameters

string
required
ID of the document.
boolean
When true, return parent application or organization branding if the document has no direct brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_BRAND_OF_DOCUMENT_GROUPReturn the brand assigned to a document group, optionally using its hierarchy.

Input Parameters

string ("true" | "false")
Use true to fall back to parent application or organization branding, or false for only a direct assignment.
string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_BRAND_TEMPLATE_FILERetrieve the reusable branding template configuration used to create a brand from a file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_CALLBACK_DETAILS_BY_IDReturn one callback delivery record within a specific event subscription using both IDs.

Input Parameters

string
required
ID of the webhook callback.
string
required
ID of the event subscription.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_CONTACT_GROUPReturn one CRM contact group’s details by group ID.

Input Parameters

string
required
ID of the contact group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_CRM_CONTACT_DETAILSReturn one CRM contact’s details by contact ID.

Input Parameters

string
required
ID of the CRM contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_DECLINED_FIELD_INVITEReturn one declined field invite using its document and field-invite IDs.

Input Parameters

string
required
ID of the document.
string
required
ID of the field invite.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_DOCUMENTReturn one document’s details, optionally including smart fields and document attributes.

Input Parameters

string
required
Document ID.
string
If used, the response will contain document attributes.
string
If used, the response will contain the list of smart fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_DOCUMENT_GENERATION_STATUSReturn the current state of a SignNow document generation process and, after completion, the generated document or document-group ID.

Input Parameters

string
required
ID of the document generation process returned when generation started.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_DOCUMENT_GROUPReturn a document group using the original document-group endpoint.

Input Parameters

string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_DOCUMENT_GROUP_DETAILSReturn detailed version 2 information for a document group.

Input Parameters

string
Documented query value that requests reminder fields.
string
required
ID of the document group.
string
Documented query value that requests document-group attributes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_DOCUMENT_GROUP_HISTORYReturn the recorded history events for one document group.

Input Parameters

string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_DOCUMENT_GROUP_INVITEReturn one invite within a specific document group using both IDs.

Input Parameters

string
required
ID of the document group invite.
string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_DOCUMENT_HISTORYReturn the recorded history events for one document.

Input Parameters

string
required
The documented document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_DOCUMENT_METADATAReturn the metadata entries attached to one document.

Input Parameters

string
required
ID of the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_EDITOR_BRAND_RESOURCEReturn the editor-specific settings configured for one brand.

Input Parameters

string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_EMAIL_BRAND_RESOURCEDeprecated: return the combined legacy email brand resource. Migrate to the current typed email-general, email-logo, and email-invite resources.

Input Parameters

string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_EMAIL_CANCELED_RESOURCEReturn the canceled-invite email settings configured for one brand.

Input Parameters

string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_EMAIL_COMPLETED_RESOURCEReturn the completed-invite email settings configured for one brand.

Input Parameters

string
required
ID of the brand. Must contain exactly 40 lowercase letters or digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_EMAIL_GENERAL_RESOURCEReturn the general email settings shared by one brand.

Input Parameters

string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_EMAIL_INVITE_RESOURCEReturn the invitation email settings configured for one brand.

Input Parameters

string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_EMAIL_LOGO_BRAND_RESOURCEDownload a brand’s email logo image.

Input Parameters

string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_EMAIL_REASSIGN_RESOURCEReturn the reassignment email settings configured for one brand.

Input Parameters

string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_EMAIL_REMINDER_RESOURCEReturn the reminder email settings configured for one brand.

Input Parameters

string
required
ID of the brand. Must contain exactly 40 lowercase letters or digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_EVENT_SUBSCRIPTION_DETAILSReturn the configuration and optional callback event count for one Webhooks 2.0 event subscription.

Input Parameters

string
required
ID of the subscription; documented format is 40 lowercase letters or digits.
boolean
When true, send the documented wire value true to include the callback event count; false is omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_FOLDER_BY_IDReturn one offset-based page of entities from a SignNow folder.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_FREEFORM_SIGNED_CC_EMAIL_BRANDINGReturn the FreeForm-signed CC email settings configured for one brand.

Input Parameters

string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_GENERAL_BRAND_RESOURCEReturn the general branding settings configured for one brand.

Input Parameters

string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_INVITE_CC_EMAIL_BRANDINGReturn the invite CC email settings configured for one brand.

Input Parameters

string
required
ID of the brand. Must contain exactly 40 lowercase letters or digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_INVITE_COMPLETED_CC_EMAIL_BRANDINGReturn the completed-invite CC email settings configured for one brand.

Input Parameters

string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_LEGACY_BRAND_RESOURCEDeprecated: return one general, editor, logo, or email resource for a legacy brand. Migrate to the current resource-specific endpoint.

Input Parameters

string
required
ID of the brand.
string ("general" | "editor" | "logo" | "email")
required
Legacy brand resource type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_LOGO_BRAND_RESOURCEDownload a brand’s logo image.

Input Parameters

string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_MERCHANT_ACCOUNTRetrieve a specific merchant account connected to a SignNow organization.

Input Parameters

string
required
ID of the requested organization.
string
required
ID of the organization merchant account to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_MONTHLY_REQUEST_TOTALSReturn paid-request usage totals grouped by dynamic YYYYMM month keys.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_ORGANIZATION_ACTIVITYReturn activity for one organization, optionally limited to events after a timestamp.

Input Parameters

string
required
ID of the organization.
string
Start timestamp for the documented activity date filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_ORGANIZATION_BRANDRetrieve details of a brand owned by an organization, including its name and owner type.

Input Parameters

string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.
string
required
ID of the organization. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_ORGANIZATION_EDITOR_BRAND_RESOURCEReturn editor-specific settings for a brand owned by a specific organization.

Input Parameters

string
required
ID of the organization brand.
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_ORGANIZATION_EMAIL_BRAND_RESOURCEReturn email-specific settings for a brand owned by a specific organization.

Input Parameters

string
required
ID of the organization brand.
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_ORGANIZATION_GENERAL_BRAND_RESOURCEReturn general settings for a brand owned by a specific organization.

Input Parameters

string
required
ID of the organization brand.
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_ORGANIZATION_LOGO_BRAND_RESOURCEReturn the logo resource for a brand owned by a specific organization.

Input Parameters

string
required
ID of the organization brand.
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_ORGANIZATION_SETTINGSReturn the settings configured for an organization.

Input Parameters

string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_PAID_REQUEST_TOTALSReturn total, used, and remaining paid-request quota.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_PERSONAL_MERCHANT_ACCOUNTRetrieve a specific merchant account connected to the current SignNow user.

Input Parameters

string
required
ID of the connected personal payment account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_REASSIGN_CC_EMAIL_BRANDINGReturn the reassignment CC email settings configured for one brand.

Input Parameters

string
required
ID of the brand. Must contain exactly 40 lowercase letters or digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_REQUEST_LOGReturn one API request log by its request ID.

Input Parameters

string
required
Request ID returned by LIST_API_REQUEST_LOGS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_SEND_INVITE_BRAND_RESOURCEReturn the send-invite settings configured for one brand.

Input Parameters

string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_SMART_FIELDS_FROM_TEMPLATEReturn the smart-field definitions configured on one template.

Input Parameters

string
required
ID of the template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_STEP_COMPLETED_CC_EMAIL_BRANDINGReturn the completed-step CC email settings configured for one brand.

Input Parameters

string
required
ID of the brand. Must contain exactly 40 lowercase letters or digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_TEAMReturn one team’s details by team ID.

Input Parameters

string
required
ID of the team to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_TEAM_INVITEReturn one team invitation by its invitation request ID.

Input Parameters

string
required
ID of the team invitation request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_USER_DETAILSReturn details for the connected SignNow user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_USER_ROLE_FOR_TEMPLATERetrieve a user’s role for a specific shared template.

Input Parameters

string
required
ID of the user whose role to retrieve.
string
required
ID of the shared template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GET_WELCOME_MESSAGEReturn the current signing welcome message for the connected account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_GRANT_TEAM_ADMIN_PERMISSIONSPromote an existing team member, selected by email, to administrator of a specific team.

Input Parameters

object
required
Documented administrator promotion request.
string
required
ID of the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_IMPORT_CRM_CONTACTS_IN_BULKImport CRM contacts in bulk from a CSV file. Existing contacts with matching emails are replaced by default; the duplicate strategy can instead be set to skip.

Input Parameters

object
required
CSV file, no larger than 5 MB and 3000 data rows.
string ("skip" | "replace")
How to handle contacts whose emails already exist.
string
required
CSV header containing contact email addresses.
string
CSV header containing phone numbers.
string
CSV header containing last names.
string
CSV header containing first names.
string
CSV header containing descriptions.
string
CSV header containing cities.
string
CSV header containing company names.
string
CSV header containing states.
string
CSV header containing street addresses.
string
CSV header containing two-character country codes.
string
CSV header containing postal codes.
string
CSV header containing apartments or units.
string
CSV header containing job titles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_IMPORT_TEMPLATE_FROM_DOCUSIGNImport one or more DocuSign templates from an exported ZIP archive.

Input Parameters

object
required
DocuSign template ZIP archive containing the exported JSON template data; the archive must be no larger than 50 MB.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_INVITE_USER_TO_TEAMSend team invitations to the email addresses supplied for one specific team.

Input Parameters

object
required
Documented list of invitee email addresses.
string
required
ID of the team to invite users to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_ADMIN_ORGANIZATIONSList one page of organizations administered by the connected user, with status and type filters.

Input Parameters

string
Positive page number starting from 1.
string
Continuation cursor from a previous page.
string
Positive page size from 1 to 100.
string
URL-encoded member, admin, or moderator role filter.
string
URL-encoded active or pending status filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_ALLOWED_TEAM_ADMINSList the users permitted to administer teams in an organization, optionally filtered by email or active state.

Input Parameters

string
required
ID of the organization.
string
Filter by the documented active-state value.
string
Filter by allowed team admin email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_API_REQUEST_LOGSReturn one page of API request logs for the active application.

Input Parameters

string
Page number starting from 1.
string
Continuation cursor returned by a previous request-log page.
string
Positive number of request logs to return per page.
string
Documented URI match or like filter expression.
string
Documented response-code range filter expression.
string
Documented request-duration filter expression.
string
Documented error filter expression.
string ("asc" | "desc")
Sort by creation time in ascending or descending order.
string
Documented HTTP method filter expression.
string
Documented creation-time range filter expression.
string
Documented application ID filter expression.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_BRANDSList a page of brands available to the connected account, with pagination metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_CALLBACKSList callback delivery records with optional event, application, status, initiator, entity, URL, and date filters.

Input Parameters

string ("asc" | "desc")
Sort by response code using asc or desc.
string ("asc" | "desc")
Sort by event using asc or desc.
string
URL-encoded response-code range filter.
string
URL-encoded callback timestamp range filter.
string
URL-encoded event filter.
string ("asc" | "desc")
Sort by callback end time using asc or desc.
string ("asc" | "desc")
Sort by callback start time using asc or desc.
string ("asc" | "desc")
Sort by application using asc or desc.
string
URL-encoded event-type filter.
string
URL-encoded application filter.
string
URL-encoded filter for entity, callback, and initiator IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_CALLBACKS_BY_EVENT_SUBSCRIPTIONList callback delivery records for one event subscription with optional status, initiator, and date filters.

Input Parameters

string ("asc" | "desc")
Sort by response code using asc or desc.
string
URL-encoded response-code range filter.
string
URL-encoded callback timestamp range filter.
string ("asc" | "desc")
Sort by callback end time using asc or desc.
string ("asc" | "desc")
Sort by callback start time using asc or desc.
string
required
ID of the event subscription.
string
URL-encoded initiator-ID filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_COMPLETED_DOCUMENT_FIELDSReturn field values from one completed document.

Input Parameters

string
required
ID of the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_CONTACT_GROUPSList one page of CRM contact groups, optionally filtered by group ID or name.

Input Parameters

string
Initial positive page number.
string
Continuation cursor returned by a previous call.
string
Positive page size from 1 to 100.
string
Group ID filter JSON string.
string
Group name filter JSON string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_CONTACT_GROUPS_FOR_CONTACTReturn one page of contact groups containing a CRM contact.

Input Parameters

string
Initial positive page number.
string
Continuation cursor returned by a previous call.
string
Positive page size from 1 to 100.
string
required
ID of the CRM contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_CONTACTS_FROM_GROUPReturn one page of contacts from a contact group.

Input Parameters

string
Page number as a positive digit string.
string ("asc" | "desc")
Sort direction. Format: sort[last_interaction_at]=“desc”.
string
Next page returned by a previous call; omit for the first page.
string
required
ID of the group.
string
Number of contacts per page as a digit string from 1 to 100.
string
Owners filter, for example: filters=[{“owners”:{“type”:“IN”,“value”:[“contact_owner_id”]}}].
string
Email filter, for example: filters=[{“email”:{“type”:”=”,“value”:“crm@email.com”}}].
string
Combined interaction and company filter.
string
Company filter, for example: filters=[{“company”:{“type”:”=”,“value”:“Best company”}}].
string
Full-name filter, for example: filters=[{“full_name”:{“type”:“like”,“value”:“value”}}].
string
Last-name filter, for example: filters=[{“last_name”:{“type”:“like”,“value”:“value”}}].
string
First-name filter, for example: filters=[{“first_name”:{“type”:“like”,“value”:“value”}}].
string
Company exclusion filter, for example: filters=[{“company”:{“type”:”!=”,“value”:“Best company”}}].
string
Shared-contact filter, for example: filters=[{“shared_with_me”:{“type”:”=”,“value”:“true”}}].
string
Combined OR filter for interaction and company fields.
string
Interaction-after filter, for example: filters=[{“interaction”:{“type”:”>”,“value”:1652918152}}].
string
Interaction-before filter, for example: filters=[{“interaction”:{“type”:”<”,“value”:1652918152}}].
string
Combined OR filter for email, first name, last name, and full name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_CRM_CONTACTSList one page of CRM contacts with optional owner, sharing, identity, company, and interaction filters.

Input Parameters

integer
Initial page number.
string
Documented CRM contact sort expression.
string
Continuation cursor returned by a previous call.
integer
Contacts per page, from 1 to 100.
string
Email filter JSON string.
string
Owners filter JSON string.
string
Company filter JSON string.
string
Full-name filter JSON string.
string
Last-name filter JSON string.
string
First-name filter JSON string.
string
Company exclusion filter JSON string.
string
Combined OR filter JSON string for email and contact names.
string
Shared-with-me filter JSON string.
string
Combined filter JSON string.
string
Interaction-after filter JSON string.
string
Interaction-before filter JSON string.
string
Combined OR filter JSON string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_CRM_USERSList one page of CRM users and return a continuation cursor.

Input Parameters

integer
Initial page number.
string
Continuation cursor returned by a previous call.
integer
Users per page, from 1 to 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_DOCUMENT_FREE_FORM_INVITESRetrieve one page of FreeForm invites for a document.

Input Parameters

integer
Page number to return, starting from 1.
string
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.
string
JSON-encoded array of filters.
integer
Number of invites to return per page, from 1 to 100.
string
required
ID of the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_DOCUMENT_GROUP_RECIPIENTSReturn the recipients configured for one document group.

Input Parameters

string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_DOCUMENT_GROUPSReturn one offset/limit page of document groups owned by the user.

Input Parameters

integer
required
Page size from 1 through 50.
string
Next offset returned by a previous call; omit for the first page.
integer
required
Zero-based result offset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_DOCUMENT_GROUPS_CREATED_FROM_TEMPLATEList one page of document groups created from a specific template, with search, status, label, and sort options.

Input Parameters

integer
Page number to display in the results. For example, if page=2 and per_page=10, you’ll get results from 11 to 20.
string
Continuation cursor returned by a previous call; omit for the first page.
string ("updated" | "created" | "document_group_name")
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.
integer
Number of document groups displayed per page.
string ("document-name" | "signer-email" | "inviter-email" | "document-text" | "document-id")
Specify where to look for the search_key. Possible values: document-name, signer-email, inviter-email, document-text, and document-id.
string
Search by key (word, part of word, or phrase).
string ("asc" | "desc")
Sort results in descending or ascending order. Possible values: asc, desc.
string
required
ID of the document group template
string ("declined" | "undelivered")
Filter results by declined or undelivered document group templates. Possible values: declined, undelivered.
string ("waiting-for-me" | "waiting-for-others" | "signed" | "pending" | "has-invites" | "expired")
Filter results by document group template signing status. Possible values: waiting-for-me, waiting-for-others, signed, pending, has-invites, expired.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_DOCUMENT_GROUP_TEMPLATE_RECIPIENTSList recipient, CC, document-role, reminder, and expiration routing settings for a document group template.

Input Parameters

string
required
ID of the document group template

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_DOCUMENT_GROUP_TEMPLATE_ROLESList one page of roles for a document group template and return a continuation cursor.

Input Parameters

integer
Page number. Min: 1. Default: 1.
string
Continuation cursor returned by a previous call; omit for the first page.
integer
Number of items per page. Min: 1, Max: 100. Default: 15.
string
required
Document group template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_DOCUMENT_GROUP_TEMPLATESList document group templates using offset or continuation-cursor pagination.

Input Parameters

string
required
The number of templates to get
string
Continuation cursor returned by a previous call; omit for the first page.
string
The number of templates to skip from the first one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_DOCUMENT_GROUP_USERSList one page of users with access to a document group and return a continuation cursor.

Input Parameters

integer
Page number for the initial request (default 1).
string
Cursor returned by a previous call; omit for the first page.
integer
Number of items per page (1-100; default 15).
string
required
Document group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_DOCUMENTS_FROM_TEMPLATEReturn one page of documents generated from a template.

Input Parameters

integer
Page number to retrieve.
string
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.
string
Use doc-from-dg to exclude documents in document groups.
string ("updated" | "created" | "document_name")
Field used to sort documents.
integer
Number of documents per page.
string ("document-name" | "signer-email" | "inviter-email" | "document-text" | "document-id")
Document field to search.
string
Keyword or phrase to search for.
string ("asc" | "desc")
Sort direction.
string
required
ID of the template.
string ("declinied" | "undelivered")
Declined or undelivered entity-label filter.
string ("waiting-for-me" | "waiting-for-others" | "signed" | "pending" | "has-invites" | "expired")
Signing status filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_DOCUMENT_USERSList one page of users with access to a document and return a continuation cursor.

Input Parameters

integer
Page number for an initial direct page request.
string
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.
integer
Number of users per page (1-100; default 15).
string
required
Document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_EMAIL_FOOTERSReturn a page of legacy organization email footers with pagination metadata. This action is deprecated.

Input Parameters

string
required
ID of the organization where the email footer is set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_EMAILS_OF_THE_INVITE_STEPReturn the email records for one step of a specific document group invite.

Input Parameters

string
required
ID of a step in the invite.
string
required
The documented invite ID path parameter.
string
required
The documented document group ID path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_EVENT_SUBSCRIPTIONSList event subscriptions with event, application, callback URL, date, sort, and event-count options.

Input Parameters

string
Page value to retrieve.
string
Continuation cursor from a previous response.
string ("asc" | "desc")
Sort by event name using asc or desc.
string
URL-encoded timestamp range filter.
string ("asc" | "desc")
Sort by creation date using asc or desc.
string
URL-encoded event filter.
string ("asc" | "desc")
Sort by application name using asc or desc.
string
URL-encoded application filter.
boolean
Whether to include event counts; serialized as lowercase true or false.
string
URL-encoded filter for entity IDs and callback URLs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_FAVORITESReturn one page of documents and document groups marked as favorites.

Input Parameters

string
Page number to return as a positive digit string. Defaults to 1.
string
Next page returned by a previous call; omit for the first page.
string
Number of favorites per page as a positive digit string. Defaults to 15.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_FOLDERSReturn the connected user’s root folder tree and its documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_FREE_FORM_INVITE_DOCUMENTSRetrieve one page of documents for a document-group FreeForm invite.

Input Parameters

string
Page number to return, represented as a string starting at 1.
string
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.
string
Number of documents to return per page, represented as a string from 1 to 100.
string
required
ID of the document group.
string
required
ID of the document-group FreeForm invite.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_LEGACY_EVENT_SUBSCRIPTIONSDeprecated: list Webhooks 1.0 event subscriptions for the connected user. Migrate to the current GET /v2/event-subscriptions endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_MEMBERS_LAST_LOGINSReturn the last-login audit records for organization members.

Input Parameters

string
required
ID of the organization.
string ("asc" | "desc")
Sort records by email using asc or desc.
string ("asc" | "desc")
Sort records by update time using asc or desc.
string
Filter records by member email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_METADATA_OF_DOCUMENT_GROUPReturn the documented metadata response for a document group.

Input Parameters

string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_MODIFIED_DOCUMENTSReturn user documents that have been modified with fields or content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_ORGANIZATION_ADMINSList administrators of one organization, optionally filtered by email or administrator type.

Input Parameters

string
required
ID of the requested organization.
string
URL-encoded active, pending, or declined status filter.
string
URL-encoded email filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_ORGANIZATION_BRANDSList the brands owned by an organization with their configured resources and pagination metadata.

Input Parameters

string
required
ID of the organization. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_ORGANIZATION_MEMBERSList members of one organization with optional email, member-type, and email-sort controls.

Input Parameters

string
required
ID of the requested organization.
string ("asc" | "desc")
Email sort direction, asc or desc.
string
URL-encoded active, pending, or declined status filter.
string
URL-encoded email filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_ORGANIZATION_USER_DOCUMENTSSearch and return one page of documents belonging to organization users.

Input Parameters

integer
Page number to retrieve.
string
Continuation cursor returned by a previous call.
integer
Documents per page.
string ("asc" | "desc")
Sort direction for document name.
string ("asc" | "desc")
Sort direction for creation time.
string
Documented document-name filter expression.
string
Documented document-text filter expression.
string ("asc" | "desc")
Sort direction for update time.
string
Documented owner-email filter expression.
string
required
ID of the organization.
string
Documented signer-email filter expression.
string ("waiting_for_signing" | "signed" | "pending_payment")
Document status filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_PAID_REQUEST_LOGSList one page of paid API request charge records and return a cursor for the next page.

Input Parameters

string
Page number starting from 1.
string
Continuation cursor returned by a previous paid-request log page.
string
Documented paid-request date range filter expression.
string
Documented paid-request type filter expression.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_PENDING_DOCUMENT_GROUP_INVITESReturn pending invite data for a specific invite within one document group.

Input Parameters

string
required
ID of the document group invite.
string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_PINNED_TEMPLATESList the templates pinned in a specific Templates folder or subfolder.

Input Parameters

string
required
ID of a Templates folder or subfolder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_TEAM_ADMINSList the administrators of a specific team, including its primary administrator.

Input Parameters

string
required
ID of the team whose admins to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_TEAM_DOCUMENT_GROUP_TEMPLATESDeprecated: return one page of document group templates shared with a team. SignNow recommends listing the contents of the relevant team folders instead.

Input Parameters

string
required
Maximum templates to return, expressed as a string from 1 through 50.
string
Continuation cursor returned by a previous call; omit for the first page.
string
Zero-based result offset expressed as a non-negative integer string.
string
required
ID of the team whose shared document group templates to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_TEAM_MEMBERSList the members and administrators of a specific team, optionally including declined invitations.

Input Parameters

string
required
ID of the team whose members to return.
boolean
Include users who declined an invitation to join the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_TEMPLATE_RECIPIENTSList a template’s signer, viewer, approver, and carbon-copy routing configuration.

Input Parameters

string
required
Template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_USER_DOCUMENTSReturn the connected user’s documents that have not yet been modified.

Input Parameters

string ("desc" | "asc")
Sort templates by the date their invite was last sent. Applies to system and custom template folders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_USERS_ACTIVITYReturn document activity statistics for users in an organization.

Input Parameters

string
required
ID of the organization.
string
Documented starting timestamp filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_USERS_BY_CONTACTReturn users connected to a CRM contact.

Input Parameters

integer
Initial page number.
string
Continuation cursor returned by a previous call.
string
Positive page size from 1 to 100.
string
required
ID of the CRM contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_LIST_USER_TEAMSList the teams associated with the connected SignNow user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_MARK_DOCUMENT_AS_FAVORITEAdd a document in the Documents folder to the user’s favorites.

Input Parameters

string
required
ID of the document to add to favorites (40 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_MARK_DOCUMENT_GROUP_AS_FAVORITEAdd a document group in the Documents folder to the user’s favorites.

Input Parameters

string
required
ID of the document group to add to favorites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_MERGE_DOCUMENTSCreate one merged document from the documents specified in the request body.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_MOVE_DOCUMENTRelocate one document according to the destination supplied in the move payload.

Input Parameters

object
required
Documented move-document JSON body.
string
required
The documented document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_MOVE_DOCUMENT_GROUPMove a document group and its eligible documents to another folder.

Input Parameters

object
required
The documented destination and shared-document options.
string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_MOVE_DOCUMENT_GROUP_TEMPLATEMove a document group template to a destination folder, optionally moving active document groups based on the template as well.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the document group template

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_MOVE_DOCUMENTS_IN_BULKMove up to 25 supplied documents into one target folder in a single request.

Input Parameters

array
required
Documented array of documents to move.
string
required
ID of the target folder to move documents into.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_MOVE_ORGANIZATION_MEMBERS_BATCHMove 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

array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_PREFILL_SMART_FIELDSPrefill smart fields on a document using the case-sensitive field names field_name1 and field_name2.

Input Parameters

object
required
Documented smart-field prefill body.
string
required
ID of the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_PREFILL_TEXT_FIELDSSet text-field values on one existing document before it is completed.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the requested document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_REMOVE_ACCESS_TO_TEMPLATERevoke a user’s access to a shared template.

Input Parameters

string
required
ID of the user whose access to revoke.
string
required
ID of the shared template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_REMOVE_ADMIN_MODERATORRemove one administrator or moderator from a specific organization by admin ID.

Input Parameters

string
required
ID of the organization.
string
required
ID of the admin or moderator to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_REMOVE_CONTACT_FROM_GROUPRemove one CRM contact from a contact group without deleting the contact.

Input Parameters

string
required
ID of the contact group.
string
required
ID of the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_REMOVE_DOCUMENT_FROM_FAVORITESRemove a document in the Documents folder from the user’s favorites.

Input Parameters

string
required
ID of the document to remove from favorites (40 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_REMOVE_DOCUMENT_GROUP_FROM_FAVORITESRemove a document group in the Documents folder from the user’s favorites.

Input Parameters

string
required
ID of the document group to remove from favorites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_REMOVE_METADATA_FROM_DOCUMENT_GROUPDelete every metadata entry attached to one document group.

Input Parameters

string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_REMOVE_ORGANIZATION_MEMBERS_BATCHRemove 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

string
required
Organization to remove members from.
array
required
1-100 member IDs to remove sequentially. This batch is not atomic; each item receives an independent result.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_REMOVE_TEAM_ADMINRemove one administrator from the team, ending their team membership and revoking their shared-folder access. Sends downgrade_only=false.

Input Parameters

string
required
ID of the team.
string
required
ID of the team administrator.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_RENAME_DOCUMENT_GROUPReplace the name of one existing document group.

Input Parameters

object
required
The officially documented document-group rename body.
string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_RENAME_FOLDERReplace the name of one folder using its folder ID and the supplied rename payload.

Input Parameters

object
required
The documented folder rename body.
string
required
ID of the folder to rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_RENAME_ORGANIZATIONReplace the name of one organization using the supplied rename payload.

Input Parameters

object
required
Documented organization rename payload.
string
required
ID of the requested organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_RENAME_TEAMReplace the name of one team while leaving its membership unchanged.

Input Parameters

object
required
Documented replacement name for the team.
string
required
ID of the team to rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_REPLACE_SIGNERReplace 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

string
required
ID of the document whose replacement field invite will be sent.
object
required
Replacement signer settings matching SignNow’s official field-invite schema.
string
required
ID of the existing field invite to delete before replacing its signer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_RESEND_CALLBACKRedeliver one callback for a specific event subscription using both IDs.

Input Parameters

string
required
Documented callback ID path parameter.
string
required
Documented subscription ID path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_RESEND_DOCUMENT_GROUP_INVITEResend a specific document group invite using its group and invite IDs.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
The documented invite id path parameter.
string
required
The documented document group id path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_RESEND_EMAIL_INVITEResend the email invitation for a specific field invite request.

Input Parameters

string
required
ID of the field invite request whose email invitation to resend.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_RESEND_FREEFORM_INVITEResend a document-group FreeForm invite to one signer.

Input Parameters

string
required
ID of the signer.
string
required
ID of the document group.
string
required
ID of the document-group FreeForm invite.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_RESET_WELCOME_MESSAGE_TO_DEFAULTDelete the custom signing welcome message so the account uses its default message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_RESPOND_TO_ORGANIZATION_ADMIN_INVITEAccept or decline an organization admin or moderator invitation according to the decision parameter.

Input Parameters

string
required
ID of the organization where the role is changed.
string
required
ID of the user whose role is changed.
string ("accept" | "decline")
required
Accept or decline the organization admin or moderator invitation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_RESPOND_TO_TEAM_INVITEAccept or decline invitation to a team.

Input Parameters

object
required
Documented accept-or-decline decision.
string
required
ID of the team invitation request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_REVOKE_SHARED_CONTACT_ACCESSRemove one user’s access to a CRM contact previously shared with that user; the contact itself is not deleted.

Input Parameters

string
required
ID of the user whose access will be revoked.
string
required
ID of the shared CRM contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_SEARCH_DOCUMENTS_TEMPLATES_AND_GROUPSSearch for documents, templates, and document groups.

Input Parameters

integer
Page number to return, starting at 1.
string
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.
integer
Number of results per page, from 1 through 20.
string
required
Comma-separated fields to search: name, id, inviter-email, signer-email, or document-text.
string
required
Search phrase. Must be a non-empty string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_SEND_BULK_TEMPLATE_INVITEGenerate and invite multiple documents from one template using SignNow’s documented CSV multipart workflow.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_SEND_DOCUMENT_GROUP_BY_EMAILIrreversibly email a copy of one document group to one recipient using the supplied delivery settings.

Input Parameters

object
required
Documented JSON body for emailing a copy of the document group.
string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_SEND_DOCUMENT_GROUP_INVITEIrreversibly send signing invitations for one document group using the supplied routing payload.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
The ID of the document group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_SEND_DOCUMENT_INVITESend a field, free-form, or payment-request invitation for a document using the officially documented request shape for that invitation type.

Input Parameters

string
required
Request body matching an officially documented semantic variant; do not accept fields absent from every documented schema or example.
string
required
ID of the document

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_SEND_DOCUMENT_SMS_INVITEIrreversibly send an SMS signing invitation for one document using the supplied invite payload.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
Document ID used for SMS invite.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_SEND_FAXSend the fax described in the request body; the delivery action is irreversible.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_SEND_GROUP_PAYMENT_INVITESend a document-group invite containing fixed or calculated payment requests.

Input Parameters

object
required
Document-group invite containing fixed or calculated payment requests.
string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_SEND_SCHEDULED_INVITEIrreversibly send an existing scheduled document or document-group invite now and return its delivery result.

Input Parameters

string
required
ID of the document or document group whose scheduled invite is sent immediately.
string ("document" | "document_group")
required
Type of SignNow resource whose scheduled invite is sent immediately.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_SET_ALLOWED_TEAM_ADMINAdd one email address as an allowed team admin for an organization.

Input Parameters

object
required
Allowed team admin to add.
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_SHARE_CONTACT_WITH_OTHER_USERSGrant users view-only access to one existing CRM contact.

Input Parameters

object
required
Documented contact sharing payload.
string
required
ID of the CRM contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_SHARE_DOCUMENTGrant document access according to the recipients and permissions in the sharing payload.

Input Parameters

object
required
Documented document-sharing JSON body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_SHARE_DOCUMENT_GROUPGrant access to one document group according to the supplied sharing settings.

Input Parameters

object
required
Documented document group sharing request body.
string
required
Document group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_SHARE_DOCUMENT_GROUP_TEMPLATEGrant access to one document group template according to the supplied sharing settings.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
Document group template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_SHARE_TEAM_DOCUMENT_GROUP_TEMPLATEDeprecated: share a document group template with a team. SignNow recommends moving the template into a team folder or subfolder instead.

Input Parameters

string
required
ID of the team that will receive the document group template.
string
required
ID of the document group template to share with the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_SHARE_TEMPLATEShare a template once with another user as a sender or viewer.

Input Parameters

object
required
The documented template sharing payload.
string
required
ID of the template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_TERMINATE_ACCESS_TOKENIrreversibly revoke the current access token so it can no longer authorize requests.

Input Parameters

object
required
The required empty JSON object documented by SignNow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UNASSIGN_BRANDUnassign a brand from an application using the legacy generic assignment route. DEPRECATED: Migrate to DELETE /v2/applications/{application_id}/brand.

Input Parameters

object
required
Documented brand unassignment payload.
string
required
The documented brand id path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UNASSIGN_BRAND_FROM_APPLICATIONRemove the direct brand assignment from an application.

Input Parameters

string
required
ID of the application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UNASSIGN_BRAND_FROM_DOCUMENTRemove the direct brand assignment from a document.

Input Parameters

string
required
ID of the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UNASSIGN_BRAND_FROM_DOCUMENT_GROUPRemove the direct brand assignment from a document group.

Input Parameters

string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UNASSIGN_BRAND_FROM_ORGANIZATIONRemove a brand as the default for one organization without deleting the brand itself.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of an organization. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UNSHARE_DOCUMENT_FROM_ALL_USERSRevoke every user’s shared access to one document in a single operation.

Input Parameters

string
required
Document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UNSHARE_DOCUMENT_FROM_USERRevoke one specified user’s shared access to a document.

Input Parameters

string
required
ID of the user to unshare.
string
required
Document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UNSHARE_DOCUMENT_GROUP_FROM_ALL_USERSRevoke every user’s shared access to one document group in a single operation.

Input Parameters

string
required
Document group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UNSHARE_DOCUMENT_GROUP_FROM_USERRevoke one specified user’s shared access to a document group.

Input Parameters

string
required
ID of the user to unshare.
string
required
Document group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UNSHARE_DOCUMENT_GROUP_TEMPLATE_FROM_USERRevoke one specified user’s shared access to a document group template.

Input Parameters

string
required
ID of the user to unshare.
string
required
Document group template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UNSHARE_GROUP_TEMPLATE_FROM_ALL_USERSRevoke every user’s shared access to one document group template in a single operation.

Input Parameters

string
required
Document group template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UNSHARE_TEAM_DOCUMENT_GROUP_TEMPLATEDeprecated: remove a document group template from a team. SignNow recommends moving the template back to a personal folder instead.

Input Parameters

string
required
ID of the team from which to remove the document group template.
string
required
ID of the document group template to remove from the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_BRANDUpdate the name of an existing brand.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_CANCELED_INVITE_EMAIL_BRANDINGApply canceled-invite email branding to one brand; this update is marked irreversible.

Input Parameters

object
required
Localized canceled-invite email branding.
string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_COMPLETED_INVITE_EMAIL_BRANDINGApply completed-invite email branding to one brand; this update is marked irreversible.

Input Parameters

object
required
Documented completed-invite email branding settings.
string
required
ID of the brand. Must contain exactly 40 lowercase letters or digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_CONTACT_GROUPRename one CRM contact group without changing its contacts.

Input Parameters

object
required
Documented contact group update payload.
string
required
ID of the contact group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_CRM_CONTACTUpdate one existing CRM contact from the supplied contact payload.

Input Parameters

object
required
Documented CRM contact update payload.
string
required
ID of the CRM contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_DOCUMENTUpdate a document by adding fields, including payment-request fields. The request can also change the document name and add signatures, text, checkmarks, lines, and checkbox groups; it requires at least one field.

Input Parameters

string
required
Request body matching an officially documented semantic variant; do not accept fields absent from every documented schema or example.
string
required
Document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_DOCUMENT_GROUPReorder documents or update the completion-email action for a document group that has no pending or fulfilled signature invites.

Input Parameters

object
required
The documented document-group order and completion-email changes.
string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_DOCUMENT_GROUP_INVITEIrreversibly update one step of a specific document group invite.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the invite step to update.
string
required
ID of the document group invite.
string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_DOCUMENT_GROUP_RECIPIENTSUpdate recipient routing for one existing document group from the supplied payload.

Input Parameters

object
required
Documented recipient configuration JSON body.
string
required
ID of the document group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_DOCUMENT_GROUP_ROLEChange one user’s role on a specific document group.

Input Parameters

object
required
Documented document group role update request body.
string
required
ID of the user whose role is being changed.
string
required
Document group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_DOCUMENT_GROUP_TEMPLATEUpdate one document group template from the supplied template settings.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the document group template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_DOCUMENT_GROUP_TEMPLATE_RECIPIENTSUpdate recipient routing for one document group template from the supplied payload.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the document group template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_DOCUMENT_GROUP_TEMPLATE_ROLEChange one user’s role on a specific document group template.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the user whose role is being changed.
string
required
Document group template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_EMAIL_LOGO_FROM_URLAdd and update email logo for brand from URL.

Input Parameters

object
required
Documented email logo URL payload.
string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_EVENT_SUBSCRIPTIONUpdate one existing legacy event subscription’s callback or event settings.

Input Parameters

object
required
Documented event-subscription update body.
string
required
ID of the subscription; documented format is 40 lowercase letters or digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_FREEFORM_SIGNED_CC_EMAIL_BRANDINGApply English FreeForm-signed CC email branding to one brand; this update is marked irreversible.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_INVITE_CC_EMAIL_BRANDINGApply invite CC email branding to one brand; this update is marked irreversible.

Input Parameters

object
required
Documented invite CC email branding settings.
string
required
ID of the brand. Must contain exactly 40 lowercase letters or digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_INVITE_COMPLETED_CC_EMAIL_BRANDINGApply English completed-invite CC email branding to one brand; this update is marked irreversible.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_INVITE_EMAIL_BRANDINGApply invitation email branding to one brand; this update is marked irreversible.

Input Parameters

object
required
Localized invite email branding.
string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_ORGANIZATION_ADMIN_ROLEChange one user’s administrator or moderator role within a specific organization.

Input Parameters

object
required
Documented role update payload.
string
required
ID of the organization where the role is changed.
string
required
ID of the user whose role is changed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_ORGANIZATION_BRANDUpdate the name of one brand owned by an organization.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.
string
required
ID of the organization. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_ORGANIZATION_SETTINGSUpdate one named organization setting.

Input Parameters

object
required
Documented organization setting update.
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_REASSIGN_CC_EMAIL_BRANDINGApply reassignment CC email branding to one brand; this update is marked irreversible.

Input Parameters

object
required
Documented reassign CC email branding settings.
string
required
ID of the brand. Must contain exactly 40 lowercase letters or digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_REASSIGN_EMAIL_BRANDINGApply reassignment email branding to one brand; this update is marked irreversible.

Input Parameters

object
required
Localized reassignment email branding.
string
required
ID of the brand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_REMINDER_EMAIL_BRANDINGApply reminder email branding to one brand; this update is marked irreversible.

Input Parameters

object
required
Documented reminder email branding settings.
string
required
ID of the brand. Must contain exactly 40 lowercase letters or digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_ROLE_FOR_TEMPLATEChange a user’s role for a shared template as its owner.

Input Parameters

object
required
The documented template-role update payload.
string
required
ID of the user whose role will change.
string
required
ID of the template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_SCHEDULED_INVITEReschedule an active document or document-group invite to a new future Unix timestamp.

Input Parameters

object
required
Updated scheduled timestamp.
string
required
ID of the document or document group whose active scheduled invite is updated.
string ("document" | "document_group")
required
Type of SignNow resource whose active scheduled invite is updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_SIGNING_WELCOME_MESSAGEReplace the connected account’s signing welcome message with the supplied text.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_STEP_COMPLETED_CC_EMAIL_BRANDINGApply completed-step CC email branding to one brand; this update is marked irreversible.

Input Parameters

object
required
Documented step-completed CC email branding settings.
string
required
ID of the brand. Must contain exactly 40 lowercase letters or digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_TEAM_INVITE_STATUSUpdate the status of a waiting team invite.

Input Parameters

object
required
Documented team invite status update.
string
required
ID of the invite to join the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_TEMPLATE_RECIPIENTSUpdate a template’s signer, viewer, approver, carbon-copy, completion, and branding routing details.

Input Parameters

object
required
Documented template routing fields to replace or update.
string
required
Template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPDATE_USER_DETAILSUpdate 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

object
required
The connected user’s first name, last name, or password to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPLOAD_DOCUMENTCreate a document from an uploaded file, optionally detecting simple text tags.

Input Parameters

object
required
Document file to upload to SignNow.
boolean
If true, you can upload a document with simple text tags. For more information, see Upload document with tags.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPLOAD_DOCUMENT_FROM_URLCreate a document by having SignNow fetch the source URL supplied in the request body.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPLOAD_DOCUMENT_WITH_TAGSCreate a document from a file while parsing optional complex text tags with a selected parse flow.

Input Parameters

object
required
Tagged document file to upload to SignNow.
string
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 }
string ("tag" | "adobe" | "all" | "default")
Determines the parse flow for document text tags. Possible values: tag, adobe, all, default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPLOAD_ORGANIZATION_LOGOUpload an image file as the organization logo.

Input Parameters

object
required
Image file to upload as the organization logo.
string
required
ID of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGN_NOW_UPSERT_SEND_INVITE_BRANDINGCreate or replace a brand’s send-invite page branding settings, including visibility and panel colors. This update is marked irreversible.

Input Parameters

object
required
Request body matching the officially documented schema; do not accept undocumented fields.
string
required
ID of the brand. Must match the pattern: [a-z0-9]{40}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not