Foxit eSign (Preview)

Foxit eSign is an electronic signature solution that lets you send, sign, and manage documents online — eliminating the need for printing, scanning, or mailing. Upload your document, define signature fields, and send it to recipients for fast, legally binding eSignatures.

This connector is available in the following products and regions:

Service	Class	Regions
Copilot Studio	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	Foxit eSign Support
URL	https://www.foxit.com
Email	api@foxit.com

Connector Metadata
Publisher	Foxit Software Inc.
Website	https://www.foxit.com/esign-pdf/
Privacy policy	https://www.foxit.com/company/privacy-policy.html
Categories	Productivity;Content and Files

Foxit eSign

Foxit eSign is an enterprise-grade electronic signature solution that enables businesses to send, sign, and manage legally binding documents entirely online — eliminating the need for printing, scanning, or mailing. Upload your document, define signature fields, and send it to recipients for fast, secure eSignatures. Foxit eSign is fully compliant with major electronic signature laws including ESIGN and UETA, uses encryption to protect documents in transit and at rest, and supports multi-factor authentication to ensure only authorised signers can access and sign your documents.

The Foxit eSign connector for Microsoft Power Automate enables you to automate your complete document signing workflow — from creating envelopes and sending them for signature, to tracking status, downloading completed documents, managing templates, and triggering downstream actions when envelope events occur.

Publisher: Foxit Corporation

Prerequisites

To use this connector, you will need:

A Microsoft Power Apps or Power Automate plan with custom connector or premium connector access
A Foxit eSign account — create one here
API access enabled on your Foxit eSign account (see Obtaining Credentials below)

Obtaining Credentials

Create a Foxit eSign account if you do not already have one.
Contact the Foxit Sales team to request API access to be enabled on your account. Once approved, API access will be activated on your account.
In Power Automate, search for Foxit eSign in the connector list and select Create connection.
You will be redirected to the Foxit eSign sign-in page. Sign in with your Foxit eSign credentials to authorize the connection.
Once authorized, the connection is ready to use in your flows.

Getting Started

After creating a connection, you can start building flows using the Foxit eSign connector:

Use triggers to start a flow automatically when an envelope event occurs (e.g., when all parties have signed).
Use actions to create envelopes, send signature reminders, download completed documents, manage templates, and more.
Chain multiple actions together — for example, create an envelope from a template, wait for the fully executed trigger, then download the signed document and store it in SharePoint.

Supported Triggers

Trigger	Description
When an envelope is sent	Fires when an envelope is sent to recipients. Requires Webhook Level set to Account.
When an envelope is viewed	Fires when a recipient opens and views the envelope.
When an envelope is signed	Fires when a recipient signs the envelope.
When an envelope is cancelled	Fires when an envelope is cancelled by a recipient or the sender.
When an envelope is fully executed	Fires when all recipients have signed and the envelope is fully completed.
When an envelope is deleted	Fires when an envelope is deleted.

Supported Actions

Envelopes

Action	Description
Create Envelope from URL	Creates and sends an envelope using a publicly accessible PDF URL.
Create Envelope from Base64	Creates and sends an envelope using a Base64-encoded PDF document.
Create Envelope from Template	Creates and sends an envelope from an existing Foxit eSign template.
Get Envelope Details	Retrieves the full details and current status of an envelope.
Get Envelope IDs	Retrieves a list of envelope IDs based on filter criteria.
Send Signature Reminder	Sends a reminder notification to pending signers of an envelope.
Download Envelope Files	Downloads all signed documents in an envelope as a zip file.
Download Single Document PDF	Downloads a single document from an envelope as a PDF.
Move Envelopes to Recycle Bin	Moves one or more envelopes to the recycle bin.
Cancel Envelope	Cancels an envelope and notifies recipients.
Delete Envelopes	Permanently deletes one or more envelopes.
Get Envelope Activity History	Retrieves the full activity log for an envelope.
Get Deleted Envelope History	Retrieves the history of deleted envelopes in the account.

Templates

Action	Description
Create Template from URL	Creates a reusable signing template using a publicly accessible PDF URL.
Create Template from Base64	Creates a reusable signing template using a Base64-encoded PDF document.
Get Template Details	Retrieves the full details of a specific template including field definitions.
Get Templates by Template IDs	Retrieves details for one or more templates by their IDs.
Get a List of All Templates	Retrieves all templates available in the account.

Webhooks

Action	Description
List All Webhook Channels	Returns a list of all webhook channels configured in the account.
Get Webhook Channel Details	Retrieves the details of a specific webhook channel.

Email Groups

Action	Description
Create Email Group	Creates a new email group for use as recipients in envelopes.
Get Email Group Details	Retrieves the details and members of an email group.

Reports

Action	Description
Download Report	Downloads an account activity report in Microsoft Excel format.

Known Issues and Limitations

Rate Limit: The Foxit eSign API allows up to 4,000 requests per 5 minutes per account. Requests that exceed this limit receive a 429 Too Many Requests response. It is recommended to implement retry logic with exponential backoff in your flows to handle this gracefully.
File Size Limit: The maximum file size per document is 25 MB. This limit applies to individual files, not the total envelope size.
Webhook Auto-Unsubscribe: Due to a limitation in the Foxit eSign webhook deletion API (which uses a POST method rather than DELETE), Power Automate cannot automatically clean up webhook channel subscriptions when a trigger-based flow is deleted or modified. Use the List All Webhook Channels action to identify active channels and the Foxit eSign portal to remove subscriptions when decommissioning a flow.
When an envelope is sent — Account Level Only: The "When an envelope is sent" trigger only fires when the Webhook Level is set to Account. It does not fire for envelopes created at the API App level. Ensure you select Account level when configuring this trigger.
Regional Availability: The connector is available for both North America (NA1) and EU region accounts. Select the appropriate server region when configuring your connection. Connecting to the wrong region will result in authentication failures.
Base64 Document Size: When using the Create Envelope from Base64 or Create Template from Base64 actions, the Base64-encoded string must correspond to a source file no larger than 25 MB.

Support

For developer support, contact the Foxit eSign team at devsupport@foxitsoftware.com.

To submit a support case, visit https://kb.foxit.com/s/submit-a-case.

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Cancel Envelope	Cancels a sent envelope. Recipients will no longer be able to sign the documents.
Create Email Group	Creates a new email group that can be used to send envelopes to multiple recipients at once.
Create Envelope from Base64	Creates and sends an envelope using a Base64-encoded PDF document.
Create Envelope from Template	Creates and sends an envelope using an existing template. Recipient details can be customized.
Create Envelope from URL	Creates and sends an envelope using publicly accessible PDF URLs. Provide the document URLs and recipient details to initiate the signing process.
Create Template from Base64	Creates a new template using a Base64-encoded PDF string. Use this when your PDF file is already available as a Base64 string in your flow, for example from a SharePoint file or OneDrive document.
Create Template from URL	Creates a new template using a publicly accessible PDF URL.
Delete Envelopes	Permanently deletes one or more envelopes.
Download Envelope Files	Downloads the completed documents from an envelope as a file.
Download Report	Downloads an envelope activity report as a Microsoft Excel file. Use the filters to narrow results by status, date range, envelope name, author, or signer.
Download Single Document PDF	Downloads a single document from an envelope as a PDF file.
Get a list of all Templates	Returns a list of all templates available in your account.
Get Deleted Envelope History	Retrieves a history of envelopes that have been deleted or moved to the recycle bin.
Get Email Group Details	Retrieves details of an existing email group.
Get Envelope Activity History	Retrieves a full activity log for an envelope, showing all actions taken by recipients and the sender.
Get Envelope Details	Retrieves full details of an envelope, including its status, recipients, and documents.
Get Envelope Ids	Returns a list of envelope IDs filtered by status. Use this to find envelopes in a specific state.
Get Template Details	Retrieves the full details of a specific template, including its fields and recipients.
Get Templates by Template Ids	Retrieves details for one or more templates by their IDs.
Get Webhook Channel Details	Retrieves the details of a specific webhook channel.
List all Webhook Channels	Returns a list of all webhook channels configured in your account.
Move Envelopes to Recycle Bin	Moves one or more envelopes to the recycle bin. Envelopes in the recycle bin are not permanently deleted.
Send Signature Reminder	Sends a reminder notification to pending recipients of an envelope, prompting them to complete signing.
Unsubscribe Webhook Trigger	Deletes an active webhook channel subscription by its channel ID. Use this action to clean up webhook subscriptions that are no longer needed.

Cancel Envelope

Operation ID:: CancelEnvelope

Cancels a sent envelope. Recipients will no longer be able to sign the documents.

Parameters

Name	Key	Required	Type	Description
Envelope ID	folderId	True	integer	The ID of the envelope to cancel.
Reason For Cancellation	reason_for_cancellation	True	string	The reason for cancelling this envelope. This is recorded in the envelope activity history.

Returns

Name	Path	Type	Description
Result	result	string	Indicates whether the request was successful.
Cancelled Envelope IDs	folders cancelled	array of integer	The list of envelope IDs that were successfully cancelled.

Create Email Group

Operation ID:: CreateEmailGroup

Creates a new email group that can be used to send envelopes to multiple recipients at once.

Parameters

Name	Key	Required	Type	Description
Group Name	emailGroupName	True	string	The name for the new email group.
Group Description	emailGroupDescription		string	An optional description for the email group.
Allow Advanced Email Validation	allowAdvancedEmailValidation		boolean	When enabled, Foxit eSign validates that all email addresses in the group are reachable before sending.
First Name	firstName	True	string	The first name of the recipient.
Last Name	lastName	True	string	The last name of the recipient.
Email	emailId	True	string	The email address of the recipient.

Returns

Name	Path	Type	Description
Result	result	string	Indicates whether the request was successful.
Message	message	string	A confirmation message for the action performed.
Group ID	emailGroup.groupId	integer	The unique identifier of the email group. Use this ID when sending envelopes to the group.
Group Name	emailGroup.groupName	string	The name of the email group.
Group Description	emailGroup.groupDesc	string	The description of the email group.
Date Created	emailGroup.dateCreated	integer	The date the email group was created, in Unix milliseconds.
Company ID	emailGroup.companyId	integer	The company account this email group belongs to.
Parties	emailGroup.parties	array of object	The list of recipients in the email group.
First Name	emailGroup.parties.firstName	string	The first name of the recipient.
Last Name	emailGroup.parties.lastName	string	The last name of the recipient.
Email	emailGroup.parties.emailId	string	The email address of the recipient.

Create Envelope from Base64

Operation ID:: CreateEnvelopefromBase64

Creates and sends an envelope using a Base64-encoded PDF document.

Parameters

Name	Key	Required	Type	Description
Envelope Name	folderName	True	string	The name of this envelope.
Input Type	inputType		string	Input type for document source. Fixed to base64 for this action.
Base64 File Strings	base64FileString	True	array of string	An array of Base64 encoded PDF documents to send.
File Names	fileNames	True	array of string	An array of display names for each document, in the same order as the Base64 File String array.
First Name	firstName	True	string	The first name of the recipient.
Last Name	lastName	True	string	The last name of the recipient.
Email Address	emailId	True	string	The email address of the recipient.
permissions	permission	True	string
Sequence	sequence	True	integer	Use this field to assign a sequence number to a recipient in the list of recipient parties. Use unique sequence numbers for each party starting with 1 like 1,2,3,4.... If a single person appears multiple times in the signing workflow, please assign a different sequence each time the recipient is repeated.
signerAuthLevels	signerAuthLevel		string	The level of authentication that a signer will leverage for verification purposes
Is Placeholder	isPlaceholder		boolean	Use this field to initiate the party is a placeholder. Note: 1. firstName, lastName, emailId parameter's value must be blank of this party. 2. To add the placeholder, one recipient must be requred with 'PARTY_ASSIGNER' permission.
Recipient Role	partyRole		string	Use this field to assign a role of placeholder.
Allow Name Change	allowNameChange		string	Value can be either true or false Use this parameter for allowing signer to update first and last name before completing the signing process.
Workflow Sequence	workflowSequence		integer	Assign a workflow sequence number to this recipient. When Sign In Sequence is enabled, recipients receive their signing invitation in ascending sequence order.
Host Email Id	hostEmailId		string	Email address of In-Person Administrator.
Access Code	userDefinedAccessCode		string	The parameter will contain Access Code when "signerAuthLevel" value is set as "User-defined Access Code" for authentication. Note: 1. Codes are not case-sensitive. 2. The system does not send this code so you must share this code with the signer directly. 3. Access code can contain alphabets, numbers and the following special characters: @,&,{,},%,(,),~,\|,!,+,^.
Party Is Email Group	partyIsEmailGroup		boolean	Use this parameter when creating a party as bulk. Note: If this parameter is true, firstName, lastName and emailId of this party will be ignored.
Email Group Id	emailGroupId		integer	Pass the email the group id you want to use to create bulk.
Single Signer Bulk	allowSingleSignerInBulk		boolean	Use this parameter to allow only one person to sign in email group.
Dialing Code	dialingCode		string	Use this field to assign a country dial-in codes are mobile number prefixes to a recipient in the list of recipient parties.
Mobile Number	mobileNumber		string	Use this field to assign a mobile number to a recipient in the list of recipient parties.
Fields	Fields		object
Send Now	sendNow		boolean	When enabled, Foxit eSign immediately sends a unique signing link to each recipient's email address. Disable this to save the envelope as a draft instead.
Create Embedded Signing Session	createEmbeddedSigningSession	True	boolean	Signing session token will be generated without sending out emails to the recipients.
Create Embedded Signing Session For All Parties	createEmbeddedSigningSessionForAllParties		boolean	If set to true, an embedded signing URL will be generated for every recipient in the envelope.
Process Text Tags	processTextTags	True	boolean	Value can be either true or false. This field is used to determine whether Foxit eSign should parse the documents for Text Tags to convert them into Foxit eSign fields.
Process Acro Fields	processAcroFields	True	boolean	This field is used to determine whether Foxit eSign should parse the documents for AcroFields to convert them into Foxit eSign fields.
Sign In Sequence	signInSequence		boolean	This field is used to determine whether recipients will sign the envelope documents in a sequence. If false, then all the recipients receive invitation email simultaneously. When true, then each recipient receives invitation email successively after previous recipient completes the required task, like signing the documents or filling fields, etc.
In Person Enable	inPersonEnable		boolean	This field is used to initiate the in-person signing process which can be easily completed on any device in a matter of minutes and avoids email based signatures where required. If false, then all the recipients receive the invitation email simultaneously. When true, then in-person administrator receives an invitation email to initiate the signing process for the signer.
Fix Recipient Parties	fixRecipientParties		boolean	If true, then in the embedded sending view cannot change the parties for the envelope which are already added as a part of this request.
Fix Documents	fixDocuments		boolean	If true, then in the embedded sending cannot change the documents for the envelope which are already added as a part of this request.
Send Success Url	sendSuccessUrl		string	Enter the absolute URL for the landing page, which the signer will be redirected to after successfully sending the folder in the embedded sending view.
Send Error Url	sendErrorUrl		string	Enter the absolute URL for the landing page, which the signer will be redirected to if error comes during sending the folder in the embedded sending view.
Create Embedded Sending Session	createEmbeddedSendingSession		boolean	If set to true, it will generate an embedded token to open the document preparing view of Foxit eSign.
Embedded Signers Email Ids	embeddedSignersEmailIds		array of string	An array of email ids of recipients for whom an embedded signing session needs to be created. The email ids from the recipient parties added in the parties list.
Sign Success Url	signSuccessUrl		string	Enter the absolute URL for the signers who will be redirected to after successfully signing in embedded signing view.
Sign Decline Url	signDeclineUrl		string	Enter the absolute URL for the signers who will be redirected to if declines to sign in embedded signing view.
Sign Later Url	signLaterUrl		string	Enter the absolute URL for the signers who will be redirected to if chooses to sign later in embedded signing view.
Sign Error Url	signErrorUrl		string	Enter the absolute URL for the signers who will be redirected to if error comes during signing the document in embedded signing view.
Allow Send Now And Embedded Signing Session	allowSendNowAndEmbeddedSigningSession		boolean	If set as true, Foxit eSign will send unique signing link to each recipient. This is ONLY applicable when parameters sendNow and createEmbeddedSigningSession is true.
Advanced Email Validation	allowAdvancedEmailValidation		boolean	Validate the email address of the parties when set as true.
Sign Success Url All Parties	signSuccessUrlAllParties		boolean	If set as true, signer will be redirected to URL provided in the signSuccessUrl after successfully signing. This is only applicable when the sendNow is true.
Email Template ID	emailTemplateId		integer	Pass the email template Id to send the email templates other than default email templates.
Signer Instruction Id	signerInstructionId		integer	Pass the instruction Id to send signer instructions other than the default signer instructions.
Confirmation Instruction Id	confirmationInstructionId		string	Pass the confirmation instruction id to send confirmation instructions other than the default confirmation instructions.
Theme Color	themeColor		string	Enter the CSS value to set the theme color.
Session Expire	sessionExpire		boolean	Set as true to initiate the expire of the embedded signing session.
Expiry	expiry		integer	Required if sessionExpire is true. Enter duration in milliseconds of the expiry on the embedded signing session.
Dependent Field Name	dependentFieldName	True	string	The name of the field whose visibility is controlled by the parent field.
Parent Field Name	parentFieldName	True	string	The name of the parent field whose value controls the visibility of the dependent field. Supported parent field types: textfield, textbox, checkbox, radiobutton, dropdown.
Parent Field Value	parentFieldValue	True	string	The value of the parent field that triggers the dependent field to become visible. For checkbox and radio button fields, use checked or unchecked.
Options	options	True	string	Additional matching options for text-based parent fields. Accepted values: isblank, allowNull, contains.
Metadata	metadata		object	This should be in key value pair. Maximum 1000 key value pairs are allowed.
Sender Email	senderEmail		string	enter email of another user in your account which will be used for sending this document(s) folder to the recipient parties.
Hide Add Me Button	hideAddMeButton		boolean	If true, it will hide the "Add Me" button on Recipient Parties in an embedded sending session.
Hide Add New Button	hideAddNewButton		boolean	If true, it will hide the "Add New" button on Recipient Parties in an embedded sending session.
Hide Add Group Button	hideAddGroupButton		boolean	If true, it will hide the "Add Group" button on Recipient Parties in an embedded sending session.
Hide Field Name For Recipients	hideFieldNameForRecipients		boolean	Hide field names for Recipients for Data Entry Fields and Advanced Fields. (Except Radio button, Checkbox, Image and Hyperlink).
Hide Checkbox Border	hideCheckboxBorder		boolean	Borders of Checkbox will be hidden in the executed documents.
Hide Signer Select Option	hideSignerSelectOption		boolean	If true, it will hide the "Existing Signer Name/Email" input box on Recipient Parties in an embedded sending session.
Hide Signer Actions	hideSignerActions		boolean	If true, it will hide the signer "edit", "change" and "remove" actions on Recipient Parties in an embedded sending session.
Hide Sender Name	hideSenderName		boolean	If true, it will hide the sender name on Recipient Parties in an embedded sending session.
Hide Folder Name	hideFolderName		boolean	If true, it will hide the folder name on navigation in both embedded sessions.
Hide Documents Name	hideDocumentsName		boolean	If true, it will hide the document name in both embedded sessions.
Hide Decline To Sign	hideDeclineToSign		boolean	If true, it will hide the option of "Decline to Sign" for the signer.
Hide More Action	hideMoreAction		boolean	If true, it will hide "More Actions" button in sending/signing session. In case of "Send Now": true, it will not hide anything.
Hide Send Button	hideSendButton		boolean	If true, it will hide the Send button in the embedded sending session.
Hide Next Required Fieldbtn	hideNextRequiredFieldbtn		boolean	If set to true, hides the navigation button that moves signers to the next required field.
Required Both Embedded Session	requiredBothEmbeddedSession		boolean	If true, it will generate the embedded sending and signing URLs together.
Envelope Password	folderPassword		string	This password will be required by the signer/author in order to open the digitally signed document. If the parameter is kept blank then no password will be required to open the digitally signed document.
Enable Step By Step	enableStepByStep		boolean	To enable step by step action in the embedded sending session.
Hide Add Parties Option	hideAddPartiesOption		boolean	If true, it will hide the option to add parties option in Draft and Template Creation mode.
Self Sign	selfSign		boolean	It enables embedded Self Sign via APIs. This parameter is only applicable when the createEmbeddedSendingSession parameter is true.
Self Signer Success Url	selfSignerSuccessUrl		string	Enter the absolute URL for the landing page on your website/application, which the user will be redirected to after successfully Self Sign sending the folder in the embedded sending view.

Returns

Name	Path	Type	Description
ID	folder.folderId	integer	The unique ID of the newly created envelope. Use this in subsequent actions to reference this envelope.
Name	folder.folderName	string	The name of the newly created envelope.
Custom Name	folder.folderCustomName	string	A custom name for the envelope.
Password	folder.folderPassword	string	The access password for the envelope, if set.
Creator ID	folder.folderAuthorId	integer	The unique identifier of the envelope creator.
Creator First Name	folder.folderAuthorFirstName	string	The envelope creator's first name.
Creator Last Name	folder.folderAuthorLastName	string	The envelope creator's last name.
Creator Email	folder.folderAuthorEmail	string	The envelope creator's email address.
Creator Role	folder.folderAuthorRole	string	The role of the envelope creator.
Company ID	folder.folderCompanyId	integer	The unique identifier of the company that owns the envelope.
Created Date	folder.folderCreationDate	integer	The date the envelope was created (Unix timestamp in milliseconds).
Sent Date	folder.folderSentDate	integer	The date the envelope was sent (Unix timestamp in milliseconds).
Status	folder.folderStatus	string	The current status of the envelope.
Custom Field 1	folder.custom_field1	string	The first custom metadata field for the envelope.
Custom Field 2	folder.custom_field2	string	The second custom metadata field for the envelope.
Metadata	folder.metadata	string	Custom metadata associated with the envelope.
Document IDs	folder.folderDocumentIds	array of integer	The list of document IDs contained in the envelope.
Documents	folder.documentsList	array of object	The list of documents in the envelope.
Document ID	folder.documentsList.documentId	integer	The unique identifier of the document.
Contract ID	folder.documentsList.contractId	integer	The unique identifier of the contract.
Company ID	folder.documentsList.companyId	integer	The unique identifier of the company.
Created By	folder.documentsList.contractCreatedBy	integer	The user ID of the person who created the contract.
Created On	folder.documentsList.contractCreatedOn	string	The date and time the contract was created.
Contract Type	folder.documentsList.contractType	string	The type of the contract.
Contract Status	folder.documentsList.contractStatus	string	The current status of the contract.
Editable	folder.documentsList.editable	boolean	Indicates whether the item is editable.
Version ID	folder.documentsList.contractVersionId	integer	The unique identifier of the contract version.
Version Name	folder.documentsList.contractVersionName	string	The name of the contract version.
Version Description	folder.documentsList.contractVersionDesc	string	A description of the contract version.
Version Created By	folder.documentsList.versionCreatedby	integer	The user ID of the person who created this version.
Version Created On	folder.documentsList.versionCreatedOn	string	The date and time this version was created.
Version Number	folder.documentsList.contractVersionNumber	integer	The version number of the contract.
Transaction Source	folder.documentsList.contractTransactionSource	string	The source system that initiated the contract transaction.
Recipients	folder.folderRecipientParties	array of object	The list of recipient parties for this envelope.
Recipient ID	folder.folderRecipientParties.partyId	integer	The unique identifier of the recipient.
Recipient ID	folder.folderRecipientParties.partyDetails.partyId	integer	The unique identifier of the recipient.
First Name	folder.folderRecipientParties.partyDetails.firstName	string	The recipient's first name.
Last Name	folder.folderRecipientParties.partyDetails.lastName	string	The recipient's last name.
Email Address	folder.folderRecipientParties.partyDetails.emailId	string	The email address of the recipient.
Placeholder	folder.folderRecipientParties.partyDetails.placeholder	boolean	Indicates whether this party is a placeholder recipient.
Address	folder.folderRecipientParties.partyDetails.address	string	The physical address of the recipient.
Date Created	folder.folderRecipientParties.partyDetails.dateCreated	integer	The date the record was created (Unix timestamp in milliseconds).
Opt Out Emails	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Indicates whether the recipient has opted out of email notifications.
Unique Recipient ID	folder.folderRecipientParties.partyDetails.uniquePartyId	string	A unique system identifier for this recipient.
Auth Level	folder.folderRecipientParties.partyDetails.authenticationLevel	string	The authentication method required for this recipient.
Password Updated Date	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	The date the password was last updated.
Password Updated Status	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Indicates whether the password has been updated.
Company ID	folder.folderRecipientParties.partyDetails.companyId	integer	The unique identifier of the company.
User Role	folder.folderRecipientParties.partyDetails.userRole	string	The role assigned to the user.
Department	folder.folderRecipientParties.partyDetails.department	string	The department the user belongs to.
Title	folder.folderRecipientParties.partyDetails.title	string	The job title of the user.
Active	folder.folderRecipientParties.partyDetails.active	boolean	Indicates whether the user or record is active.
Locale	folder.folderRecipientParties.partyDetails.requestLocale	string	The locale setting for the user.
Share with Dept	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Indicates whether envelopes are shared across the department.
Dialing Code	folder.folderRecipientParties.partyDetails.dialingCode	string	The international dialing code for the phone number.
Mobile Number	folder.folderRecipientParties.partyDetails.mobileNumber	string	The mobile phone number.
Status Filter	folder.folderRecipientParties.partyDetails.docStatusFilter	string	A filter for document status.
Date Filter	folder.folderRecipientParties.partyDetails.docDateFilter	string	A filter for document date.
Secure Field Access	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Indicates whether the user has access to secure fields.
Expand Sidebar	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Indicates whether the sidebar is expanded by default.
Adv. Email Validation	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Indicates whether advanced email validation is enabled.
Manager ID	folder.folderRecipientParties.partyDetails.managerId	string	The unique identifier of the user's manager.
Login Count	folder.folderRecipientParties.partyDetails.loginCount	integer	The number of times the user has logged in.
Password Reset Email	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Indicates whether a password reset email should be sent.
Department ID	folder.folderRecipientParties.partyDetails.departmentId	string	The unique identifier of the department.
Primary Company	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	The primary company associated with the user.
Device Type	folder.folderRecipientParties.partyDetails.deviceType	string	The type of device used.
Device Token	folder.folderRecipientParties.partyDetails.deviceToken	string	The push notification token for the device.
Subcontractor Description	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	A description of the subcontractor or external signer.
Subcontractor Organization	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	The organization name of the subcontractor or external signer.
Subcontractor Added Date	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	The date the subcontractor was added (Unix timestamp in milliseconds).
Source	folder.folderRecipientParties.partyDetails.source	string	The source system from which the external signer was added.
Dialing Code	folder.folderRecipientParties.dialingCode	string	The international dialing code for the phone number.
Mobile Number	folder.folderRecipientParties.mobileNumber	string	The mobile phone number.
Signature Type	folder.folderRecipientParties.signerSignatureType	string	The type of signature the signer will use.
Permissions	folder.folderRecipientParties.contractPermissions	string	The permissions granted to this party for the contract.
Signing Order	folder.folderRecipientParties.partySequence	integer	The signing order sequence number for this recipient.
Workflow Sequence	folder.folderRecipientParties.workflowSignSequence	integer	The workflow signing sequence number.
Envelope ID	folder.folderRecipientParties.envelopeId	integer	The unique identifier of the envelope.
Recipient Company ID	folder.folderRecipientParties.partyCompanyId	integer	The unique identifier of the company associated with this recipient.
Sharing Mode	folder.folderRecipientParties.sharingMode	string	The sharing mode for this envelope.
Recipient Access URL	folder.folderRecipientParties.folderAccessURL	string	The URL the recipient can use to access and sign the envelope.
Security Mode	folder.folderRecipientParties.securityMode	string	The security mode applied to this envelope.
Comments	folder.folderRecipientParties.extraComments	string	Additional comments included with the envelope.
Allow Name Change	folder.folderRecipientParties.allowNameChange	boolean	Indicates whether the recipient is allowed to update their name.
Name Updated	folder.folderRecipientParties.signerNameUpdated	boolean	Indicates whether the signer has updated their name.
Signer Auth Level	folder.folderRecipientParties.signerAuthenticationLevel	string	The authentication level required for the signer.
Access Code	folder.folderRecipientParties.userDefinedAccessCode	string	A custom access code defined for the signer.
Signature ID	folder.folderRecipientParties.signatureId	string	The unique identifier of the signature.
Recipient Role	folder.folderRecipientParties.partyRole	string	The role assigned to this recipient in the signing workflow.
Company Field	folder.folderRecipientParties.companyFieldValue	string	The value of the company name field in the signature.
Title Field	folder.folderRecipientParties.titleFieldValue	string	The value of the title field in the signature.
Reason for Signing	folder.folderRecipientParties.reasonSigning	string	The reason the recipient is signing the document.
Payment Field Added	folder.folderRecipientParties.payFieldAdded	boolean	Indicates whether a payment field has been added.
Payee	folder.folderRecipientParties.payee	boolean	Indicates whether this recipient is the payee.
Recurring Payment	folder.folderRecipientParties.recurringFieldExist	boolean	Indicates whether a recurring payment field exists.
Print and Sign Done	folder.folderRecipientParties.printAndSignCompleted	boolean	Indicates whether the print-and-sign process is complete.
Paid	folder.folderRecipientParties.paid	boolean	Indicates whether payment has been completed.
Optional Signer Allowed	folder.folderRecipientParties.allowOptionalSigner	boolean	Indicates whether this recipient is an optional signer.
Optional Signers	folder.folderRecipientParties.optionalSigners	array of integer	The list of optional signer party IDs for this envelope.
Author Signing URL	folder.folderAccessURLForAuthor	string	The URL the sender can use to access the envelope.
Draft Access URL	folder.draftFolderAccessURL	string	The URL used to access the draft version of the envelope.
Boardroom Signing	folder.boardRoomSign	boolean	Indicates whether board room signing mode is enabled.
Include Logo	folder.includeLogo	boolean	Indicates whether the company logo is included in emails.
Button Background Color	folder.email_btnBgColor	string	The background color of the email button.
Button Text Color	folder.email_btnTxtColor	string	The text color of the email button.
Email Logo	folder.emailTemplateLogo	string	The logo URL used in the email template.
Email Template ID	folder.emailTemplateId	integer	The unique identifier of the email template.
Email Header	folder.emailHeader	string	The header text used in notification emails.
Email Footer	folder.emailFooter	string	The footer text used in notification emails.
Purge Scheduled	folder.purgeFlag	boolean	Indicates whether the envelope is scheduled for purging.
Purge Start Date	folder.purgeStartDate	string	The date from which purging is scheduled to begin.
Purge End Date	folder.purgeEndDate	string	The date on which purging is scheduled to complete.
Bulk Send ID	folder.bulkId	integer	The unique identifier of the bulk send operation.
Enforce Sign Order	folder.enforceSignWorkflow	boolean	Indicates whether recipients must sign in the defined sequence.
Current Step	folder.currentWorkflowStep	integer	The current step in the signing workflow.
Transaction Source	folder.transactionSource	string	The source system that initiated this transaction.
Editable	folder.editable	boolean	Indicates whether the item is editable.
In-Person Signing	folder.inPersonSignable	boolean	Indicates whether the envelope can be signed in person.
Override Reminders	folder.overrideAccountReminders	boolean	Indicates whether account-level reminder settings are overridden.
Override Delegation	folder.overrideAccountRecipientDelegation	boolean	Indicates whether account-level delegation settings are overridden.
Allow Delegation	folder.allowRecipientsToDelegate	boolean	Indicates whether recipients are allowed to delegate signing.
ID	folder.envelopeId	integer	The unique identifier of the envelope.
Name	folder.envelopeName	string	The name of the envelope.
Originator ID	folder.envelopeOriginatorId	integer	The unique identifier of the user who created the envelope.
Company ID	folder.envelopeCompanyId	integer	The unique identifier of the company that owns the envelope.
Date	folder.envelopeDate	integer	The date the envelope was created (Unix timestamp in milliseconds).
Shared Date	folder.envelopeSharedDate	integer	The date the envelope was shared (Unix timestamp in milliseconds).
Status	folder.envelopeStatus	string	The current status of the envelope.
Contract IDs	folder.envelopeContractIds	array of integer	The list of contract IDs associated with this envelope.
Recipient Permissions	folder.envelopePartyPermissions	array of object	The list of recipient permissions for this envelope.
Recipient ID	folder.envelopePartyPermissions.partyId	integer	The unique identifier of the recipient.
Recipient ID	folder.envelopePartyPermissions.partyDetails.partyId	integer	The unique identifier of the recipient.
First Name	folder.envelopePartyPermissions.partyDetails.firstName	string	The recipient's first name.
Last Name	folder.envelopePartyPermissions.partyDetails.lastName	string	The recipient's last name.
Email Address	folder.envelopePartyPermissions.partyDetails.emailId	string	The email address of the recipient.
Placeholder	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Indicates whether this party is a placeholder recipient.
Address	folder.envelopePartyPermissions.partyDetails.address	string	The physical address of the recipient.
Date Created	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	The date the record was created (Unix timestamp in milliseconds).
Opt Out Emails	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Indicates whether the recipient has opted out of email notifications.
Unique Recipient ID	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	A unique system identifier for this recipient.
Auth Level	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	The authentication method required for this recipient.
Password Updated Date	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	The date the password was last updated.
Password Updated Status	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Indicates whether the password has been updated.
Company ID	folder.envelopePartyPermissions.partyDetails.companyId	integer	The unique identifier of the company.
User Role	folder.envelopePartyPermissions.partyDetails.userRole	string	The role assigned to the user.
Department	folder.envelopePartyPermissions.partyDetails.department	string	The department the user belongs to.
Title	folder.envelopePartyPermissions.partyDetails.title	string	The job title of the user.
Active	folder.envelopePartyPermissions.partyDetails.active	boolean	Indicates whether the user or record is active.
Locale	folder.envelopePartyPermissions.partyDetails.requestLocale	string	The locale setting for the user.
Share with Dept	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Indicates whether envelopes are shared across the department.
Dialing Code	folder.envelopePartyPermissions.partyDetails.dialingCode	string	The international dialing code for the phone number.
Mobile Number	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	The mobile phone number.
Status Filter	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	A filter for document status.
Date Filter	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	A filter for document date.
Secure Field Access	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Indicates whether the user has access to secure fields.
Expand Sidebar	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Indicates whether the sidebar is expanded by default.
Adv. Email Validation	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Indicates whether advanced email validation is enabled.
Manager ID	folder.envelopePartyPermissions.partyDetails.managerId	string	The unique identifier of the user's manager.
Login Count	folder.envelopePartyPermissions.partyDetails.loginCount	integer	The number of times the user has logged in.
Password Reset Email	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Indicates whether a password reset email should be sent.
Department ID	folder.envelopePartyPermissions.partyDetails.departmentId	string	The unique identifier of the department.
Primary Company	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	The primary company associated with the user.
Device Type	folder.envelopePartyPermissions.partyDetails.deviceType	string	The type of device used.
Device Token	folder.envelopePartyPermissions.partyDetails.deviceToken	string	The push notification token for the device.
Subcontractor Description	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	A description of the subcontractor or external signer.
Subcontractor Organization	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	The organization name of the subcontractor or external signer.
Subcontractor Added Date	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	The date the subcontractor was added (Unix timestamp in milliseconds).
Source	folder.envelopePartyPermissions.partyDetails.source	string	The source system from which the external signer was added.
Dialing Code	folder.envelopePartyPermissions.dialingCode	string	The international dialing code for the phone number.
Mobile Number	folder.envelopePartyPermissions.mobileNumber	string	The mobile phone number.
Signature Type	folder.envelopePartyPermissions.signerSignatureType	string	The type of signature the signer will use.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	The permissions granted to this party for the contract.
Signing Order	folder.envelopePartyPermissions.partySequence	integer	The signing order sequence number for this recipient.
Workflow Sequence	folder.envelopePartyPermissions.workflowSignSequence	integer	The workflow signing sequence number.
Envelope ID	folder.envelopePartyPermissions.envelopeId	integer	The unique identifier of the envelope.
Recipient Company ID	folder.envelopePartyPermissions.partyCompanyId	integer	The unique identifier of the company associated with this recipient.
Sharing Mode	folder.envelopePartyPermissions.sharingMode	string	The sharing mode for this envelope.
Recipient Access URL	folder.envelopePartyPermissions.folderAccessURL	string	The URL the recipient can use to access and sign the envelope.
Security Mode	folder.envelopePartyPermissions.securityMode	string	The security mode applied to this envelope.
Comments	folder.envelopePartyPermissions.extraComments	string	Additional comments included with the envelope.
Allow Name Change	folder.envelopePartyPermissions.allowNameChange	boolean	Indicates whether the recipient is allowed to update their name.
Name Updated	folder.envelopePartyPermissions.signerNameUpdated	boolean	Indicates whether the signer has updated their name.
Signer Auth Level	folder.envelopePartyPermissions.signerAuthenticationLevel	string	The authentication level required for the signer.
Access Code	folder.envelopePartyPermissions.userDefinedAccessCode	string	A custom access code defined for the signer.
Signature ID	folder.envelopePartyPermissions.signatureId	string	The unique identifier of the signature.
Recipient Role	folder.envelopePartyPermissions.partyRole	string	The role assigned to this recipient in the signing workflow.
Company Field	folder.envelopePartyPermissions.companyFieldValue	string	The value of the company name field in the signature.
Title Field	folder.envelopePartyPermissions.titleFieldValue	string	The value of the title field in the signature.
Reason for Signing	folder.envelopePartyPermissions.reasonSigning	string	The reason the recipient is signing the document.
Payment Field Added	folder.envelopePartyPermissions.payFieldAdded	boolean	Indicates whether a payment field has been added.
Payee	folder.envelopePartyPermissions.payee	boolean	Indicates whether this recipient is the payee.
Recurring Payment	folder.envelopePartyPermissions.recurringFieldExist	boolean	Indicates whether a recurring payment field exists.
Print and Sign Done	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Indicates whether the print-and-sign process is complete.
Paid	folder.envelopePartyPermissions.paid	boolean	Indicates whether payment has been completed.
Auth Level	folder.envelopeAuthenticationLevel	string	The authentication level required for the envelope.
Single Signer Bulk	folder.allowSingleSignerInBulk	boolean	Indicates whether a single signer is allowed in bulk send mode.
File-Based Naming	folder.folderNameBasedOnFileNaming	boolean	Indicates whether the folder name is based on the file name.
Doc File-Based Name	folder.documentNameBasedOnFileNaming	boolean	Indicates whether the document name is based on the file name.
Cert File-Based Name	folder.certificateNameBasedOnFileNaming	boolean	Indicates whether the certificate name is based on the file name.
Pre-Exec File Naming	folder.enableFileNamingBeforeExecution	boolean	Indicates whether file naming is enabled before document execution.
Payee Added	folder.payeeAddedd	boolean	Indicates whether a payee has been added.
Self-Signing Enabled	folder.selfSignerEnabled	boolean	Indicates whether self-signing mode is enabled.
Notary Enabled	folder.notaryEnabled	boolean	Indicates whether notary signing is enabled.
Limited Visibility	folder.limitedVisibilityFlag	boolean	Indicates whether limited visibility is enabled for this envelope.
Post-Sign Visibility	folder.postSigningVisibility	boolean	Indicates whether post-signing visibility is enabled.
Wet Signature	folder.wetSignatureEnabled	boolean	Indicates whether wet signatures are enabled.
Merge Enabled	folder.mergeEnabled	boolean	Indicates whether document merging is enabled.
Embedded Signing Sessions	embeddedSigningSessions	array of object	The list of embedded signing sessions, one per recipient. Only present when createEmbeddedSigningSession is true.
Signer Email	embeddedSigningSessions.emailIdOfSigner	string	The email address of the recipient for this embedded signing session.
Signing Token	embeddedSigningSessions.embeddedToken	string	The unique token for this recipient's embedded signing session.
Signing Session URL	embeddedSigningSessions.embeddedSessionURL	string	The URL to open or embed for this recipient to sign the document.
Embedded Sending Token	embeddedToken	string	The token for the embedded sending session. Only present when createEmbeddedSendingSession is true.
Sending Session URL	embeddedSessionURL	string	The URL to open or embed for the envelope author to prepare and send the envelope. Only present when createEmbeddedSendingSession is true.
Result	result	string	The result of the operation.
Message	message	string	A message describing the result of the operation.

Create Envelope from Template

Operation ID:: CreateEnvelopefromTemplate

Creates and sends an envelope using an existing template. Recipient details can be customized.

Parameters

Name	Key	Required	Type	Description
Envelope Name	folderName		string	Name of the document(s) folder. If this value is not provided, then the document(s) folder name is kept same as the template(s) name(s).
Template Ids	templateIds	True	array of integer	An array of template IDs you want to use to create the documents for this folder.
Fields	fields		object	You may pass of the field values used in the templates to prefill them in the documents created from the template. FIELD_NAME is the name of the field used in the template. FIELD_VALUE is the document field value.
Advanced Email Validation	allowAdvancedEmailValidation		boolean	Validate the email addresses of the parties when set as true.
First Name	firstName	True	string	The first name of the recipient.
Last Name	lastName	True	string	The last name of the recipient.
Email Address	emailId	True	string	The email address of the recipient.
permissions	permission	True	string
Sequence	sequence	True	integer	Use this field to assign a sequence number to a recipient in the list of recipient parties. Use unique sequence numbers for each party starting with 1 like 1,2,3,4.... If a single person appears multiple times in the signing workflow, please assign a different sequence each time the recipient is repeated.
signerAuthLevels	signerAuthLevel		string	The level of authentication that a signer will leverage for verification purposes
Is Placeholder	isPlaceholder		boolean	Use this field to initiate the party is a placeholder. Note: 1. firstName, lastName, emailId parameter's value must be blank of this party. 2. To add the placeholder, one recipient must be requred with 'PARTY_ASSIGNER' permission.
Recipient Role	partyRole		string	Use this field to assign a role of placeholder.
Allow Name Change	allowNameChange		string	Value can be either true or false Use this parameter for allowing signer to update first and last name before completing the signing process.
Workflow Sequence	workflowSequence		integer	Assign a workflow sequence number to this recipient. When Sign In Sequence is enabled, recipients receive their signing invitation in ascending sequence order.
Host Email Id	hostEmailId		string	Email address of In-Person Administrator.
Access Code	userDefinedAccessCode		string	The parameter will contain Access Code when "signerAuthLevel" value is set as "User-defined Access Code" for authentication. Note: 1. Codes are not case-sensitive. 2. The system does not send this code so you must share this code with the signer directly. 3. Access code can contain alphabets, numbers and the following special characters: @,&,{,},%,(,),~,\|,!,+,^.
Party Is Email Group	partyIsEmailGroup		boolean	Use this parameter when creating a party as bulk. Note: If this parameter is true, firstName, lastName and emailId of this party will be ignored.
Email Group Id	emailGroupId		integer	Pass the email the group id you want to use to create bulk.
Single Signer Bulk	allowSingleSignerInBulk		boolean	Use this parameter to allow only one person to sign in email group.
Dialing Code	dialingCode		string	Use this field to assign a country dial-in codes are mobile number prefixes to a recipient in the list of recipient parties.
Mobile Number	mobileNumber		string	Use this field to assign a mobile number to a recipient in the list of recipient parties.
Envelope Password	folderPassword		string	This password will be required by the signer/author in order to open the digitally signed document. If the parameter is kept blank then no password will be required to open the digitally signed document.
Sign In Sequence	signInSequence		boolean	This field is used to determine whether recipients will sign the envelope documents in a sequence. If false, then all the recipients receive invitation email simultaneously. When true, then each recipient receives invitation email successively after previous recipient completes the required task, like signing the documents or filling fields, etc.
In Person Enable	inPersonEnable		boolean	This field is used to initiate the in-person signing process which can be easily completed on any device in a matter of minutes and avoids email based signatures where required. If false, then all the recipients receive the invitation email simultaneously. When true, then in-person administrator receives an invitation email to initiate the signing process for the signer.
Send Now	sendNow		boolean	When enabled, Foxit eSign immediately sends a unique signing link to each recipient's email address. Disable this to save the envelope as a draft instead.
Sign Success Url All Parties	signSuccessUrlAllParties		boolean	If set as true, signer will be redirected to URL provided in the signSuccessUrl after successfully signing. This is only applicable when the sendNow is true.
Create Embedded Sending Session	createEmbeddedSendingSession		boolean	If set to true, it will generate an embedded URL to open the document preparing view of Foxit eSign.
Fix Recipient Parties	fixRecipientParties		boolean	If true, then in the embedded sending view cannot change the parties for the envelope which are already added as a part of this request.
Fix Documents	fixDocuments		boolean	If true, then in the embedded sending cannot change the documents for the envelope which are already added as a part of this request.
Send Success Url	sendSuccessUrl		string	Enter the absolute URL for the landing page, which the signer will be redirected to after successfully sending the folder in the embedded sending view.
Send Error Url	sendErrorUrl		string	Enter the absolute URL for the landing page, which the signer will be redirected to if error comes during sending the folder in the embedded sending view.
Hide Signer Select Option	hideSignerSelectOption		boolean	If true, it will hide the "Existing Signer Name/Email" input box on Recipient Parties in an embedded sending session.
Hide Signer Actions	hideSignerActions		boolean	If true, it will hide the signer "edit", "change" and "remove" actions on Recipient Parties in an embedded sending session.
Hide Sender Name	hideSenderName		boolean	If true, it will hide the sender name on Recipient Parties in an embedded sending session.
Hide Send Button	hideSendButton		boolean	If true, it will hide the Send button in the embedded sending session.
Hide Folder Name	hideFolderName		boolean	If true, it will hide the folder name on navigation in both embedded sessions.
Hide Documents Name	hideDocumentsName		boolean	If true, it will hide the document name in both embedded sessions.
Hide Add Me Button	hideAddMeButton		boolean	If true, it will hide the "Add Me" button on Recipient Parties in an embedded sending session.
Hide Add New Button	hideAddNewButton		boolean	If true, it will hide the "Add New" button on Recipient Parties in an embedded sending session.
Hide Add Group Button	hideAddGroupButton		boolean	If true, it will hide the "Add Group" button on Recipient Parties in an embedded sending session.
Create Embedded Signing Session	createEmbeddedSigningSession		boolean	Signing session token will be generated without sending out emails to the recipients.
Create Embedded Signing Session For All Parties	createEmbeddedSigningSessionForAllParties		boolean	If set to true, an embedded signing URL is generated for every recipient in the envelope. If false, only recipients listed in Embedded Signers Email IDs receive an embedded session.
Embedded Signers Email Ids	embeddedSignersEmailIds		array of string	An array of email ids of recipients for whom an embedded signing session needs to be created. The email ids from the recipient parties added in the parties list.
Sign Success Url	signSuccessUrl		string	Enter the absolute URL for the signers who will be redirected to after successfully signing in embedded signing view.
Sign Decline Url	signDeclineUrl		string	Enter the absolute URL for the signers who will be redirected to if declines to sign in embedded signing view.
Sign Later Url	signLaterUrl		string	Enter the absolute URL for the signers who will be redirected to if chooses to sign later in embedded signing view.
Sign Error Url	signErrorUrl		string	Enter the absolute URL for the signers who will be redirected to if error comes during signing the document in embedded signing view.
Hide Next Required Field Btn	hideNextRequiredFieldBtn		boolean	If set to true, hides the navigation button that moves signers to the next required field.
Theme Color	themeColor		string	Enter the CSS value to set the theme color.
Hide Decline To Sign	hideDeclineToSign		boolean	If set to true, hides the Decline to Sign option on the signing screen.
Hide More Action	hideMoreAction		boolean	If set to true, hides the More Actions button in the sending and signing session. Has no effect when Send Now is true.
Hide Add Parties Option	hideAddPartiesOption		boolean	If set to true, hides the option to add parties in Draft and Template Creation mode.
Session Expire	sessionExpire		boolean	Set as true to initiate the expire of the embedded signing session.
Expiry	expiry		integer	Required if sessionExpire is true. Enter duration in milliseconds of the expiry on the embedded signing session.
Sender Email	senderEmail		string	enter email of another user in your account which will be used for sending this document(s) folder to the recipient parties.
Allow Send Now And Embedded Signing Session	allowSendNowAndEmbeddedSigningSession		boolean	If set to true, Foxit eSign sends a signing invitation email to each recipient and also generates an embedded signing link for recipients whose email is included in Embedded Signer Email. Both the email and the embedded link are active simultaneously.
Enable Step By Step	enableStepByStep		boolean	To enable step by step action in the embedded sending session.

Returns

Name	Path	Type	Description
Result	result	string	Indicates whether the operation succeeded (e.g., 'success').
Message	message	string	A description of the operation outcome.
Embedded Signing Sessions	embeddedSigningSessions	array of object	The list of embedded signing sessions, one per recipient. Only present when createEmbeddedSigningSession is true.
Signer Email	embeddedSigningSessions.emailIdOfSigner	string	The email address of the recipient for this embedded signing session.
Signing Token	embeddedSigningSessions.embeddedToken	string	The unique token for this recipient's embedded signing session.
Signing Session URL	embeddedSigningSessions.embeddedSessionURL	string	The URL to open or embed for this recipient to sign the document.
Embedded Sending Token	embeddedToken	string	The token for the embedded sending session. Only present when createEmbeddedSendingSession is true.
Sending Session URL	embeddedSessionURL	string	The URL to open or embed for the envelope author to prepare and send the envelope. Only present when createEmbeddedSendingSession is true.
ID	folder.folderId	integer	The unique ID of the created envelope. Use this to reference the envelope in subsequent actions.
Name	folder.folderName	string	The name of the envelope.
Custom Name	folder.folderCustomName	string	The custom name assigned to the envelope.
Password	folder.folderPassword	string	The password set for the envelope, if any.
Author ID	folder.folderAuthorId	integer	The unique ID of the user who created the envelope.
Author First Name	folder.folderAuthorFirstName	string	The first name of the envelope creator.
Author Last Name	folder.folderAuthorLastName	string	The last name of the envelope creator.
Author Email	folder.folderAuthorEmail	string	The email address of the envelope creator.
Author Role	folder.folderAuthorRole	string	The account role of the envelope creator.
Company ID	folder.folderCompanyId	integer	The unique ID of the company the envelope belongs to.
Creation Date	folder.folderCreationDate	integer	The date and time the envelope was created, in Unix milliseconds.
Sent Date	folder.folderSentDate	integer	The date and time the envelope was sent to recipients, in Unix milliseconds.
Status	folder.folderStatus	string	The current status of the envelope (e.g., SHARED, EXECUTED, DRAFT, CANCELLED).
Custom Field 1	folder.custom_field1	string	The value of custom field 1 set on the envelope.
Custom Field 2	folder.custom_field2	string	The value of custom field 2 set on the envelope.
Metadata	folder.metadata	string	Any additional metadata associated with the envelope.
Document IDs	folder.folderDocumentIds	array of integer	The list of document IDs included in this envelope.
Documents	folder.documentsList	array of object	Details of each document included in the envelope.
Document ID	folder.documentsList.documentId	integer	The unique identifier of the document.
Contract ID	folder.documentsList.contractId	integer	The unique identifier of the contract associated with this document.
Company ID	folder.documentsList.companyId	integer	The unique ID of the company this document belongs to.
Created By	folder.documentsList.contractCreatedBy	integer	The user ID of the person who created the contract.
Created On	folder.documentsList.contractCreatedOn	string	The date the contract was created.
Contract Type	folder.documentsList.contractType	string	The type of the contract.
Document Status	folder.documentsList.contractStatus	string	The current signing status of the document (e.g., WAITING_FOR_SIGNATURE, EXECUTED).
Editable	folder.documentsList.editable	boolean	Indicates whether the document can be edited.
Version ID	folder.documentsList.contractVersionId	integer	The unique ID of the current document version.
Version Name	folder.documentsList.contractVersionName	string	The name of the current document version.
Version Description	folder.documentsList.contractVersionDesc	string	A description of the current document version.
Version Created By	folder.documentsList.versionCreatedby	integer	The user ID of the person who created this document version.
Version Created On	folder.documentsList.versionCreatedOn	string	The date this document version was created.
Version Number	folder.documentsList.contractVersionNumber	integer	The version number of the document.
Transaction Source	folder.documentsList.contractTransactionSource	string	The source of the contract transaction.
Recipients	folder.folderRecipientParties	array of object	The list of recipients for this envelope, including their individual signing links.
Recipient ID	folder.folderRecipientParties.partyId	integer	The unique identifier of the recipient.
Recipient ID	folder.folderRecipientParties.partyDetails.partyId	integer	The unique identifier of the recipient.
First Name	folder.folderRecipientParties.partyDetails.firstName	string	The recipient's first name.
Last Name	folder.folderRecipientParties.partyDetails.lastName	string	The recipient's last name.
Email	folder.folderRecipientParties.partyDetails.emailId	string	The recipient's email address.
Is Placeholder	folder.folderRecipientParties.partyDetails.placeholder	boolean	Indicates whether this recipient is a placeholder.
Address	folder.folderRecipientParties.partyDetails.address	string	The recipient's address.
Account Created Date	folder.folderRecipientParties.partyDetails.dateCreated	integer	The date the recipient's account was created, in Unix milliseconds.
Opt Out Emails	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Indicates whether the recipient has opted out of email notifications.
Unique Party ID	folder.folderRecipientParties.partyDetails.uniquePartyId	string	A unique string identifier for the recipient.
Authentication Level	folder.folderRecipientParties.partyDetails.authenticationLevel	string	The authentication level required for this recipient.
Company ID	folder.folderRecipientParties.partyDetails.companyId	integer	The ID of the company the recipient belongs to.
User Role	folder.folderRecipientParties.partyDetails.userRole	string	The role of the recipient within their organisation.
Department	folder.folderRecipientParties.partyDetails.department	string	The recipient's department.
Title	folder.folderRecipientParties.partyDetails.title	string	The recipient's job title.
Active	folder.folderRecipientParties.partyDetails.active	boolean	Indicates whether the recipient's account is active.
Dialing Code	folder.folderRecipientParties.partyDetails.dialingCode	string	The country dialling code for the recipient's phone number.
Mobile Number	folder.folderRecipientParties.partyDetails.mobileNumber	string	The recipient's mobile phone number.
Subcontractor Description	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	A description of the subcontractor, if applicable.
Subcontractor Organization	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	The subcontractor's organisation name, if applicable.
Subcontractor Added Date	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	The date the subcontractor was added, in Unix milliseconds.
Source	folder.folderRecipientParties.partyDetails.source	string	The source through which the recipient was added.
Dialing Code	folder.folderRecipientParties.dialingCode	string	The country dialling code for the recipient's mobile number.
Mobile Number	folder.folderRecipientParties.mobileNumber	string	The recipient's mobile number.
Signature Type	folder.folderRecipientParties.signerSignatureType	string	The type of signature allowed for this recipient.
Permissions	folder.folderRecipientParties.contractPermissions	string	The signing permissions granted to this recipient (e.g., FILL_FIELDS_AND_SIGN).
Signing Order	folder.folderRecipientParties.partySequence	integer	The position of this recipient in the signing order.
Workflow Sequence	folder.folderRecipientParties.workflowSignSequence	integer	The workflow signing sequence number for this recipient.
Envelope ID	folder.folderRecipientParties.envelopeId	integer	The ID of the envelope this recipient belongs to.
Party Company ID	folder.folderRecipientParties.partyCompanyId	integer	The ID of the company this recipient belongs to.
Sharing Mode	folder.folderRecipientParties.sharingMode	string	The method used to share the document with this recipient (e.g., email).
Signing URL	folder.folderRecipientParties.folderAccessURL	string	The unique signing URL for this recipient. Use this to share the signing link directly.
Security Mode	folder.folderRecipientParties.securityMode	string	The security mode applied to this recipient's access.
Extra Comments	folder.folderRecipientParties.extraComments	string	Any additional comments included in the signing invitation for this recipient.
Allow Name Change	folder.folderRecipientParties.allowNameChange	boolean	Indicates whether the recipient is allowed to change their name before signing.
Name Updated	folder.folderRecipientParties.signerNameUpdated	boolean	Indicates whether the recipient has updated their display name.
Authentication Level	folder.folderRecipientParties.signerAuthenticationLevel	string	The authentication method required for this recipient to access the document.
Access Code	folder.folderRecipientParties.userDefinedAccessCode	string	A custom access code required for this recipient to open the document.
Signature ID	folder.folderRecipientParties.signatureId	string	The ID of the saved signature used by this recipient.
Recipient Role	folder.folderRecipientParties.partyRole	string	The role assigned to this recipient in the envelope.
Company Field Value	folder.folderRecipientParties.companyFieldValue	string	The company field value pre-filled for this recipient.
Title Field Value	folder.folderRecipientParties.titleFieldValue	string	The title field value pre-filled for this recipient.
Reason for Signing	folder.folderRecipientParties.reasonSigning	string	The reason for signing provided by this recipient.
Pay Field Added	folder.folderRecipientParties.payFieldAdded	boolean	Indicates whether a payment field has been added for this recipient.
Is Payee	folder.folderRecipientParties.payee	boolean	Indicates whether this recipient is a payee.
Recurring Field Exists	folder.folderRecipientParties.recurringFieldExist	boolean	Indicates whether recurring payment fields exist for this recipient.
Print and Sign Completed	folder.folderRecipientParties.printAndSignCompleted	boolean	Indicates whether the recipient has completed a print-and-sign action.
Allow Optional Signer	folder.folderRecipientParties.allowOptionalSigner	boolean	Indicates whether this recipient can be skipped as an optional signer.
Optional Signers	folder.folderRecipientParties.optionalSigners	string	The list of optional signers associated with this recipient, if any.
Paid	folder.folderRecipientParties.paid	boolean	Indicates whether this recipient has completed payment.
Author Access URL	folder.folderAccessURLForAuthor	string	The URL for the envelope author to access the document.
Draft Access URL	folder.draftFolderAccessURL	string	The URL to access the envelope while it is in draft state.
Board Room Sign	folder.boardRoomSign	boolean	Indicates whether board room signing is enabled for this envelope.
Include Logo	folder.includeLogo	boolean	Indicates whether the company logo is included in email notifications.
Email Button Color	folder.email_btnBgColor	string	The background colour of the action button in the signing email.
Email Button Text Color	folder.email_btnTxtColor	string	The text colour of the action button in the signing email.
Email Logo	folder.emailTemplateLogo	string	The logo image used in the email template.
Email Template ID	folder.emailTemplateId	integer	The ID of the email template used for signing notifications.
Email Header	folder.emailHeader	string	The custom header text in signing notification emails.
Email Footer	folder.emailFooter	string	The custom footer text in signing notification emails.
Purge Scheduled	folder.purgeFlag	boolean	Indicates whether this envelope is scheduled for automatic purging.
Purge Start Date	folder.purgeStartDate	string	The date from which the purge period begins.
Purge End Date	folder.purgeEndDate	string	The date on which the envelope will be purged.
Bulk ID	folder.bulkId	integer	The ID of the bulk send batch this envelope belongs to, if any.
Enforce Sign Order	folder.enforceSignWorkflow	boolean	Indicates whether recipients must sign in the specified order.
Current Workflow Step	folder.currentWorkflowStep	integer	The current step in the signing workflow.
Transaction Source	folder.transactionSource	string	The source that initiated this envelope transaction.
Editable	folder.editable	boolean	Indicates whether the envelope can still be edited.
In-Person Signing	folder.inPersonSignable	boolean	Indicates whether the envelope can be signed in person.
Override Reminders	folder.overrideAccountReminders	boolean	Indicates whether account-level reminder settings are overridden for this envelope.
Override Delegation	folder.overrideAccountRecipientDelegation	boolean	Indicates whether account-level delegation settings are overridden for this envelope.
Allow Delegation	folder.allowRecipientsToDelegate	boolean	Indicates whether recipients are allowed to delegate their signing to another person.
ID	folder.envelopeId	integer	The unique ID of the envelope. Same value as Envelope ID (folderId).
Name	folder.envelopeName	string	The name of the envelope. Same value as Envelope Name (folderName).
Originator ID	folder.envelopeOriginatorId	integer	The user ID of the person who created the envelope.
Company ID	folder.envelopeCompanyId	integer	The ID of the company the envelope belongs to.
Date	folder.envelopeDate	integer	The date and time the envelope was created, in Unix milliseconds.
Shared Date	folder.envelopeSharedDate	integer	The date and time the envelope was shared with recipients, in Unix milliseconds.
Status	folder.envelopeStatus	string	The current status of the envelope. Same value as Envelope Status (folderStatus).
Contract IDs	folder.envelopeContractIds	array of integer	The list of contract IDs associated with this envelope.
Party Permissions	folder.envelopePartyPermissions	array of object	The list of recipients and their signing permissions. Same structure as Recipients.
Recipient ID	folder.envelopePartyPermissions.partyId	integer	The unique identifier of the recipient.
Signing URL	folder.envelopePartyPermissions.folderAccessURL	string	The unique signing URL for this recipient.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	The signing permissions for this recipient.
Signing Order	folder.envelopePartyPermissions.partySequence	integer	The position of this recipient in the signing order.
Authentication Level	folder.envelopeAuthenticationLevel	string	The authentication level applied to the entire envelope.
Allow Single Signer Bulk	folder.allowSingleSignerInBulk	boolean	Indicates whether a single signer is allowed in bulk send mode.
Name Based on File	folder.folderNameBasedOnFileNaming	boolean	Indicates whether the envelope name is derived from the file name.
Document Name Based on File	folder.documentNameBasedOnFileNaming	boolean	Indicates whether the document name is derived from the file name.
Certificate Name Based on File	folder.certificateNameBasedOnFileNaming	boolean	Indicates whether the certificate name is derived from the file name.
Enable File Naming	folder.enableFileNamingBeforeExecution	boolean	Indicates whether file naming is prompted before the envelope is sent.
Payee Added	folder.payeeAddedd	boolean	Indicates whether a payee has been added to the envelope.
Self Signer	folder.selfSignerEnabled	boolean	Indicates whether the sender is also a signer on this envelope.
Notary Enabled	folder.notaryEnabled	boolean	Indicates whether notarisation is enabled for this envelope.
Limited Visibility	folder.limitedVisibilityFlag	boolean	Indicates whether limited document visibility is enabled.
Post-Signing Visibility	folder.postSigningVisibility	boolean	Indicates whether recipients can view the signed document after completion.
Wet Signature Enabled	folder.wetSignatureEnabled	boolean	Indicates whether wet (handwritten) signatures are enabled for this envelope.
Merge Enabled	folder.mergeEnabled	boolean	Indicates whether document merging is enabled for this envelope.

Create Envelope from URL

Operation ID:: CreateEnvelopefromURL

Creates and sends an envelope using publicly accessible PDF URLs. Provide the document URLs and recipient details to initiate the signing process.

Parameters

Name	Key	Required	Type	Description
Envelope Name	folderName	True	string	The name of this envelope.
Input Type	inputType		string	Specifies the document source format. Set to url to provide file URLs, or base64 to provide Base64-encoded file content.
File Urls	fileUrls	True	array of string	An array of publicly accessible URLs pointing to the documents to be added to this envelope.
File Names	fileNames	True	array of string	An array of display names for each document, in the same order as File URLs.
First Name	firstName	True	string	The first name of the recipient.
Last Name	lastName	True	string	The last name of the recipient.
Email Address	emailId	True	string	The email address of the recipient.
permissions	permission	True	string
Sequence	sequence	True	integer	Use this field to assign a sequence number to a recipient in the list of recipient parties. Use unique sequence numbers for each party starting with 1 like 1,2,3,4.... If a single person appears multiple times in the signing workflow, please assign a different sequence each time the recipient is repeated.
signerAuthLevels	signerAuthLevel		string	The level of authentication that a signer will leverage for verification purposes
Is Placeholder	isPlaceholder		boolean	Use this field to initiate the party is a placeholder. Note: 1. firstName, lastName, emailId parameter's value must be blank of this party. 2. To add the placeholder, one recipient must be requred with 'PARTY_ASSIGNER' permission.
Recipient Role	partyRole		string	Use this field to assign a role of placeholder.
Allow Name Change	allowNameChange		string	Value can be either true or false Use this parameter for allowing signer to update first and last name before completing the signing process.
Workflow Sequence	workflowSequence		integer	Assign a workflow sequence number to this recipient. When Sign In Sequence is enabled, recipients receive their signing invitation in ascending sequence order.
Host Email Id	hostEmailId		string	Email address of In-Person Administrator.
Access Code	userDefinedAccessCode		string	The parameter will contain Access Code when "signerAuthLevel" value is set as "User-defined Access Code" for authentication. Note: 1. Codes are not case-sensitive. 2. The system does not send this code so you must share this code with the signer directly. 3. Access code can contain alphabets, numbers and the following special characters: @,&,{,},%,(,),~,\|,!,+,^.
Party Is Email Group	partyIsEmailGroup		boolean	Use this parameter when creating a party as bulk. Note: If this parameter is true, firstName, lastName and emailId of this party will be ignored.
Email Group Id	emailGroupId		integer	Pass the email the group id you want to use to create bulk.
Single Signer Bulk	allowSingleSignerInBulk		boolean	Use this parameter to allow only one person to sign in email group.
Dialing Code	dialingCode		string	Use this field to assign a country dial-in codes are mobile number prefixes to a recipient in the list of recipient parties.
Mobile Number	mobileNumber		string	Use this field to assign a mobile number to a recipient in the list of recipient parties.
Fields	Fields		object
Send Now	sendNow		boolean	When enabled, Foxit eSign immediately sends a unique signing link to each recipient's email address. Disable this to save the envelope as a draft instead.
Create Embedded Signing Session	createEmbeddedSigningSession	True	boolean	Signing session token will be generated without sending out emails to the recipients.
Create Embedded Signing Session For All Parties	createEmbeddedSigningSessionForAllParties		boolean	If set to true, an embedded signing URL will be generated for every recipient in the envelope.
Process Text Tags	processTextTags	True	boolean	Value can be either true or false. This field is used to determine whether Foxit eSign should parse the documents for Text Tags to convert them into Foxit eSign fields.
Process Acro Fields	processAcroFields	True	boolean	This field is used to determine whether Foxit eSign should parse the documents for AcroFields to convert them into Foxit eSign fields.
Sign In Sequence	signInSequence		boolean	This field is used to determine whether recipients will sign the envelope documents in a sequence. If false, then all the recipients receive invitation email simultaneously. When true, then each recipient receives invitation email successively after previous recipient completes the required task, like signing the documents or filling fields, etc.
In Person Enable	inPersonEnable		boolean	This field is used to initiate the in-person signing process which can be easily completed on any device in a matter of minutes and avoids email based signatures where required. If false, then all the recipients receive the invitation email simultaneously. When true, then in-person administrator receives an invitation email to initiate the signing process for the signer.
Fix Recipient Parties	fixRecipientParties		boolean	If true, then in the embedded sending view cannot change the parties for the envelope which are already added as a part of this request.
Fix Documents	fixDocuments		boolean	If true, then in the embedded sending cannot change the documents for the envelope which are already added as a part of this request.
Send Success Url	sendSuccessUrl		string	Enter the absolute URL for the landing page, which the signer will be redirected to after successfully sending the folder in the embedded sending view.
Send Error Url	sendErrorUrl		string	Enter the absolute URL for the landing page, which the signer will be redirected to if error comes during sending the folder in the embedded sending view.
Create Embedded Sending Session	createEmbeddedSendingSession		boolean	If set to true, it will generate an embedded token to open the document preparing view of Foxit eSign.
Embedded Signers Email Ids	embeddedSignersEmailIds		array of string	An array of email ids of recipients for whom an embedded signing session needs to be created. The email ids from the recipient parties added in the parties list.
Sign Success Url	signSuccessUrl		string	Enter the absolute URL for the signers who will be redirected to after successfully signing in embedded signing view.
Sign Decline Url	signDeclineUrl		string	Enter the absolute URL for the signers who will be redirected to if declines to sign in embedded signing view.
Sign Later Url	signLaterUrl		string	Enter the absolute URL for the signers who will be redirected to if chooses to sign later in embedded signing view.
Sign Error Url	signErrorUrl		string	Enter the absolute URL for the signers who will be redirected to if error comes during signing the document in embedded signing view.
Allow Send Now And Embedded Signing Session	allowSendNowAndEmbeddedSigningSession		boolean	If set as true, Foxit eSign will send unique signing link to each recipient. This is ONLY applicable when parameters sendNow and createEmbeddedSigningSession is true.
Advanced Email Validation	allowAdvancedEmailValidation		boolean	Validate the email address of the parties when set as true.
Sign Success Url All Parties	signSuccessUrlAllParties		boolean	If set as true, signer will be redirected to URL provided in the signSuccessUrl after successfully signing. This is only applicable when the sendNow is true.
Email Template ID	emailTemplateId		integer	Pass the email template Id to send the email templates other than default email templates.
Signer Instruction Id	signerInstructionId		integer	Pass the instruction Id to send signer instructions other than the default signer instructions.
Confirmation Instruction Id	confirmationInstructionId		string	Pass the confirmation instruction id to send confirmation instructions other than the default confirmation instructions.
Theme Color	themeColor		string	Enter the CSS value to set the theme color.
Session Expire	sessionExpire		boolean	Set as true to initiate the expire of the embedded signing session.
Expiry	expiry		integer	Required if sessionExpire is true. Enter duration in milliseconds of the expiry on the embedded signing session.
Dependent Field Name	dependentFieldName	True	string	The name of the field whose visibility is controlled by the parent field.
Parent Field Name	parentFieldName	True	string	The name of the parent field whose value controls the visibility of the dependent field. Supported parent field types: textfield, textbox, checkbox, radiobutton, dropdown.
Parent Field Value	parentFieldValue	True	string	The value of the parent field that triggers the dependent field to become visible. For checkbox and radio button fields, use checked or unchecked.
Options	options	True	string	Additional matching options for text-based parent fields. Accepted values: isblank, allowNull, contains.
Metadata	metadata		object	This should be in key value pair. Maximum 1000 key value pairs are allowed.
Sender Email	senderEmail		string	enter email of another user in your account which will be used for sending this document(s) folder to the recipient parties.
Hide Add Me Button	hideAddMeButton		boolean	If true, it will hide the "Add Me" button on Recipient Parties in an embedded sending session.
Hide Add New Button	hideAddNewButton		boolean	If true, it will hide the "Add New" button on Recipient Parties in an embedded sending session.
Hide Add Group Button	hideAddGroupButton		boolean	If true, it will hide the "Add Group" button on Recipient Parties in an embedded sending session.
Hide Field Name For Recipients	hideFieldNameForRecipients		boolean	Hide field names for Recipients for Data Entry Fields and Advanced Fields. (Except Radio button, Checkbox, Image and Hyperlink).
Hide Checkbox Border	hideCheckboxBorder		boolean	Borders of Checkbox will be hidden in the executed documents.
Hide Signer Select Option	hideSignerSelectOption		boolean	If true, it will hide the "Existing Signer Name/Email" input box on Recipient Parties in an embedded sending session.
Hide Signer Actions	hideSignerActions		boolean	If true, it will hide the signer "edit", "change" and "remove" actions on Recipient Parties in an embedded sending session.
Hide Sender Name	hideSenderName		boolean	If true, it will hide the sender name on Recipient Parties in an embedded sending session.
Hide Folder Name	hideFolderName		boolean	If true, it will hide the folder name on navigation in both embedded sessions.
Hide Documents Name	hideDocumentsName		boolean	If true, it will hide the document name in both embedded sessions.
Hide Decline To Sign	hideDeclineToSign		boolean	If true, it will hide the option of "Decline to Sign" for the signer.
Hide More Action	hideMoreAction		boolean	If true, it will hide "More Actions" button in sending/signing session. In case of "Send Now": true, it will not hide anything.
Hide Send Button	hideSendButton		boolean	If true, it will hide the Send button in the embedded sending session.
Hide Next Required Fieldbtn	hideNextRequiredFieldbtn		boolean	If set to true, hides the navigation button that moves signers to the next required field.
Required Both Embedded Session	requiredBothEmbeddedSession		boolean	If true, it will generate the embedded sending and signing URLs together.
Envelope Password	folderPassword		string	This password will be required by the signer/author in order to open the digitally signed document. If the parameter is kept blank then no password will be required to open the digitally signed document.
Enable Step By Step	enableStepByStep		boolean	To enable step by step action in the embedded sending session.
Hide Add Parties Option	hideAddPartiesOption		boolean	If true, it will hide the option to add parties option in Draft and Template Creation mode.
Self Sign	selfSign		boolean	It enables embedded Self Sign via APIs. This parameter is only applicable when the createEmbeddedSendingSession parameter is true.
Self Signer Success Url	selfSignerSuccessUrl		string	Enter the absolute URL for the landing page on your website/application, which the user will be redirected to after successfully Self Sign sending the folder in the embedded sending view.

Returns

Name	Path	Type	Description
ID	folder.folderId	integer	The unique ID of the newly created envelope. Use this in subsequent actions to reference this envelope.
Name	folder.folderName	string	The name of the newly created envelope.
Custom Name	folder.folderCustomName	string	A custom name for the envelope.
Password	folder.folderPassword	string	The access password for the envelope, if set.
Creator ID	folder.folderAuthorId	integer	The unique identifier of the envelope creator.
Creator First Name	folder.folderAuthorFirstName	string	The envelope creator's first name.
Creator Last Name	folder.folderAuthorLastName	string	The envelope creator's last name.
Creator Email	folder.folderAuthorEmail	string	The envelope creator's email address.
Creator Role	folder.folderAuthorRole	string	The role of the envelope creator.
Company ID	folder.folderCompanyId	integer	The unique identifier of the company that owns the envelope.
Created Date	folder.folderCreationDate	integer	The date the envelope was created (Unix timestamp in milliseconds).
Sent Date	folder.folderSentDate	integer	The date the envelope was sent (Unix timestamp in milliseconds).
Status	folder.folderStatus	string	The current status of the envelope.
Custom Field 1	folder.custom_field1	string	The first custom metadata field for the envelope.
Custom Field 2	folder.custom_field2	string	The second custom metadata field for the envelope.
Metadata	folder.metadata	string	Custom metadata associated with the envelope.
Document IDs	folder.folderDocumentIds	array of integer	The list of document IDs contained in the envelope.
Documents	folder.documentsList	array of object	The list of documents in the envelope.
Document ID	folder.documentsList.documentId	integer	The unique identifier of the document.
Contract ID	folder.documentsList.contractId	integer	The unique identifier of the contract.
Company ID	folder.documentsList.companyId	integer	The unique identifier of the company.
Created By	folder.documentsList.contractCreatedBy	integer	The user ID of the person who created the contract.
Created On	folder.documentsList.contractCreatedOn	string	The date and time the contract was created.
Contract Type	folder.documentsList.contractType	string	The type of the contract.
Contract Status	folder.documentsList.contractStatus	string	The current status of the contract.
Editable	folder.documentsList.editable	boolean	Indicates whether the item is editable.
Version ID	folder.documentsList.contractVersionId	integer	The unique identifier of the contract version.
Version Name	folder.documentsList.contractVersionName	string	The name of the contract version.
Version Description	folder.documentsList.contractVersionDesc	string	A description of the contract version.
Version Created By	folder.documentsList.versionCreatedby	integer	The user ID of the person who created this version.
Version Created On	folder.documentsList.versionCreatedOn	string	The date and time this version was created.
Version Number	folder.documentsList.contractVersionNumber	integer	The version number of the contract.
Transaction Source	folder.documentsList.contractTransactionSource	string	The source system that initiated the contract transaction.
Recipients	folder.folderRecipientParties	array of object	The list of recipient parties for this envelope.
Recipient ID	folder.folderRecipientParties.partyId	integer	The unique identifier of the recipient.
Recipient ID	folder.folderRecipientParties.partyDetails.partyId	integer	The unique identifier of the recipient.
First Name	folder.folderRecipientParties.partyDetails.firstName	string	The recipient's first name.
Last Name	folder.folderRecipientParties.partyDetails.lastName	string	The recipient's last name.
Email Address	folder.folderRecipientParties.partyDetails.emailId	string	The email address of the recipient.
Placeholder	folder.folderRecipientParties.partyDetails.placeholder	boolean	Indicates whether this party is a placeholder recipient.
Address	folder.folderRecipientParties.partyDetails.address	string	The physical address of the recipient.
Date Created	folder.folderRecipientParties.partyDetails.dateCreated	integer	The date the record was created (Unix timestamp in milliseconds).
Opt Out Emails	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Indicates whether the recipient has opted out of email notifications.
Unique Recipient ID	folder.folderRecipientParties.partyDetails.uniquePartyId	string	A unique system identifier for this recipient.
Auth Level	folder.folderRecipientParties.partyDetails.authenticationLevel	string	The authentication method required for this recipient.
Password Updated Date	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	The date the password was last updated.
Password Updated Status	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Indicates whether the password has been updated.
Company ID	folder.folderRecipientParties.partyDetails.companyId	integer	The unique identifier of the company.
User Role	folder.folderRecipientParties.partyDetails.userRole	string	The role assigned to the user.
Department	folder.folderRecipientParties.partyDetails.department	string	The department the user belongs to.
Title	folder.folderRecipientParties.partyDetails.title	string	The job title of the user.
Active	folder.folderRecipientParties.partyDetails.active	boolean	Indicates whether the user or record is active.
Locale	folder.folderRecipientParties.partyDetails.requestLocale	string	The locale setting for the user.
Share with Dept	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Indicates whether envelopes are shared across the department.
Dialing Code	folder.folderRecipientParties.partyDetails.dialingCode	string	The international dialing code for the phone number.
Mobile Number	folder.folderRecipientParties.partyDetails.mobileNumber	string	The mobile phone number.
Status Filter	folder.folderRecipientParties.partyDetails.docStatusFilter	string	A filter for document status.
Date Filter	folder.folderRecipientParties.partyDetails.docDateFilter	string	A filter for document date.
Secure Field Access	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Indicates whether the user has access to secure fields.
Expand Sidebar	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Indicates whether the sidebar is expanded by default.
Adv. Email Validation	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Indicates whether advanced email validation is enabled.
Manager ID	folder.folderRecipientParties.partyDetails.managerId	string	The unique identifier of the user's manager.
Login Count	folder.folderRecipientParties.partyDetails.loginCount	integer	The number of times the user has logged in.
Password Reset Email	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Indicates whether a password reset email should be sent.
Department ID	folder.folderRecipientParties.partyDetails.departmentId	string	The unique identifier of the department.
Primary Company	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	The primary company associated with the user.
Device Type	folder.folderRecipientParties.partyDetails.deviceType	string	The type of device used.
Device Token	folder.folderRecipientParties.partyDetails.deviceToken	string	The push notification token for the device.
Subcontractor Description	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	A description of the subcontractor or external signer.
Subcontractor Organization	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	The organization name of the subcontractor or external signer.
Subcontractor Added Date	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	The date the subcontractor was added (Unix timestamp in milliseconds).
Source	folder.folderRecipientParties.partyDetails.source	string	The source system from which the external signer was added.
Dialing Code	folder.folderRecipientParties.dialingCode	string	The international dialing code for the phone number.
Mobile Number	folder.folderRecipientParties.mobileNumber	string	The mobile phone number.
Signature Type	folder.folderRecipientParties.signerSignatureType	string	The type of signature the signer will use.
Permissions	folder.folderRecipientParties.contractPermissions	string	The permissions granted to this party for the contract.
Signing Order	folder.folderRecipientParties.partySequence	integer	The signing order sequence number for this recipient.
Workflow Sequence	folder.folderRecipientParties.workflowSignSequence	integer	The workflow signing sequence number.
Envelope ID	folder.folderRecipientParties.envelopeId	integer	The unique identifier of the envelope.
Recipient Company ID	folder.folderRecipientParties.partyCompanyId	integer	The unique identifier of the company associated with this recipient.
Sharing Mode	folder.folderRecipientParties.sharingMode	string	The sharing mode for this envelope.
Recipient Access URL	folder.folderRecipientParties.folderAccessURL	string	The URL the recipient can use to access and sign the envelope.
Security Mode	folder.folderRecipientParties.securityMode	string	The security mode applied to this envelope.
Comments	folder.folderRecipientParties.extraComments	string	Additional comments included with the envelope.
Allow Name Change	folder.folderRecipientParties.allowNameChange	boolean	Indicates whether the recipient is allowed to update their name.
Name Updated	folder.folderRecipientParties.signerNameUpdated	boolean	Indicates whether the signer has updated their name.
Signer Auth Level	folder.folderRecipientParties.signerAuthenticationLevel	string	The authentication level required for the signer.
Access Code	folder.folderRecipientParties.userDefinedAccessCode	string	A custom access code defined for the signer.
Signature ID	folder.folderRecipientParties.signatureId	string	The unique identifier of the signature.
Recipient Role	folder.folderRecipientParties.partyRole	string	The role assigned to this recipient in the signing workflow.
Company Field	folder.folderRecipientParties.companyFieldValue	string	The value of the company name field in the signature.
Title Field	folder.folderRecipientParties.titleFieldValue	string	The value of the title field in the signature.
Reason for Signing	folder.folderRecipientParties.reasonSigning	string	The reason the recipient is signing the document.
Payment Field Added	folder.folderRecipientParties.payFieldAdded	boolean	Indicates whether a payment field has been added.
Payee	folder.folderRecipientParties.payee	boolean	Indicates whether this recipient is the payee.
Recurring Payment	folder.folderRecipientParties.recurringFieldExist	boolean	Indicates whether a recurring payment field exists.
Print and Sign Done	folder.folderRecipientParties.printAndSignCompleted	boolean	Indicates whether the print-and-sign process is complete.
Paid	folder.folderRecipientParties.paid	boolean	Indicates whether payment has been completed.
Optional Signer Allowed	folder.folderRecipientParties.allowOptionalSigner	boolean	Indicates whether this recipient is an optional signer.
Optional Signers	folder.folderRecipientParties.optionalSigners	array of integer	The list of optional signer party IDs for this envelope.
Author Signing URL	folder.folderAccessURLForAuthor	string	The URL the sender can use to access the envelope.
Draft Access URL	folder.draftFolderAccessURL	string	The URL used to access the draft version of the envelope.
Boardroom Signing	folder.boardRoomSign	boolean	Indicates whether board room signing mode is enabled.
Include Logo	folder.includeLogo	boolean	Indicates whether the company logo is included in emails.
Button Background Color	folder.email_btnBgColor	string	The background color of the email button.
Button Text Color	folder.email_btnTxtColor	string	The text color of the email button.
Email Logo	folder.emailTemplateLogo	string	The logo URL used in the email template.
Email Template ID	folder.emailTemplateId	integer	The unique identifier of the email template.
Email Header	folder.emailHeader	string	The header text used in notification emails.
Email Footer	folder.emailFooter	string	The footer text used in notification emails.
Purge Scheduled	folder.purgeFlag	boolean	Indicates whether the envelope is scheduled for purging.
Purge Start Date	folder.purgeStartDate	string	The date from which purging is scheduled to begin.
Purge End Date	folder.purgeEndDate	string	The date on which purging is scheduled to complete.
Bulk Send ID	folder.bulkId	integer	The unique identifier of the bulk send operation.
Enforce Sign Order	folder.enforceSignWorkflow	boolean	Indicates whether recipients must sign in the defined sequence.
Current Step	folder.currentWorkflowStep	integer	The current step in the signing workflow.
Transaction Source	folder.transactionSource	string	The source system that initiated this transaction.
Editable	folder.editable	boolean	Indicates whether the item is editable.
In-Person Signing	folder.inPersonSignable	boolean	Indicates whether the envelope can be signed in person.
Override Reminders	folder.overrideAccountReminders	boolean	Indicates whether account-level reminder settings are overridden.
Override Delegation	folder.overrideAccountRecipientDelegation	boolean	Indicates whether account-level delegation settings are overridden.
Allow Delegation	folder.allowRecipientsToDelegate	boolean	Indicates whether recipients are allowed to delegate signing.
ID	folder.envelopeId	integer	The unique identifier of the envelope.
Name	folder.envelopeName	string	The name of the envelope.
Originator ID	folder.envelopeOriginatorId	integer	The unique identifier of the user who created the envelope.
Company ID	folder.envelopeCompanyId	integer	The unique identifier of the company that owns the envelope.
Date	folder.envelopeDate	integer	The date the envelope was created (Unix timestamp in milliseconds).
Shared Date	folder.envelopeSharedDate	integer	The date the envelope was shared (Unix timestamp in milliseconds).
Status	folder.envelopeStatus	string	The current status of the envelope.
Contract IDs	folder.envelopeContractIds	array of integer	The list of contract IDs associated with this envelope.
Recipient Permissions	folder.envelopePartyPermissions	array of object	The list of recipient permissions for this envelope.
Recipient ID	folder.envelopePartyPermissions.partyId	integer	The unique identifier of the recipient.
Recipient ID	folder.envelopePartyPermissions.partyDetails.partyId	integer	The unique identifier of the recipient.
First Name	folder.envelopePartyPermissions.partyDetails.firstName	string	The recipient's first name.
Last Name	folder.envelopePartyPermissions.partyDetails.lastName	string	The recipient's last name.
Email Address	folder.envelopePartyPermissions.partyDetails.emailId	string	The email address of the recipient.
Placeholder	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Indicates whether this party is a placeholder recipient.
Address	folder.envelopePartyPermissions.partyDetails.address	string	The physical address of the recipient.
Date Created	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	The date the record was created (Unix timestamp in milliseconds).
Opt Out Emails	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Indicates whether the recipient has opted out of email notifications.
Unique Recipient ID	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	A unique system identifier for this recipient.
Auth Level	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	The authentication method required for this recipient.
Password Updated Date	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	The date the password was last updated.
Password Updated Status	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Indicates whether the password has been updated.
Company ID	folder.envelopePartyPermissions.partyDetails.companyId	integer	The unique identifier of the company.
User Role	folder.envelopePartyPermissions.partyDetails.userRole	string	The role assigned to the user.
Department	folder.envelopePartyPermissions.partyDetails.department	string	The department the user belongs to.
Title	folder.envelopePartyPermissions.partyDetails.title	string	The job title of the user.
Active	folder.envelopePartyPermissions.partyDetails.active	boolean	Indicates whether the user or record is active.
Locale	folder.envelopePartyPermissions.partyDetails.requestLocale	string	The locale setting for the user.
Share with Dept	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Indicates whether envelopes are shared across the department.
Dialing Code	folder.envelopePartyPermissions.partyDetails.dialingCode	string	The international dialing code for the phone number.
Mobile Number	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	The mobile phone number.
Status Filter	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	A filter for document status.
Date Filter	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	A filter for document date.
Secure Field Access	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Indicates whether the user has access to secure fields.
Expand Sidebar	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Indicates whether the sidebar is expanded by default.
Adv. Email Validation	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Indicates whether advanced email validation is enabled.
Manager ID	folder.envelopePartyPermissions.partyDetails.managerId	string	The unique identifier of the user's manager.
Login Count	folder.envelopePartyPermissions.partyDetails.loginCount	integer	The number of times the user has logged in.
Password Reset Email	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Indicates whether a password reset email should be sent.
Department ID	folder.envelopePartyPermissions.partyDetails.departmentId	string	The unique identifier of the department.
Primary Company	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	The primary company associated with the user.
Device Type	folder.envelopePartyPermissions.partyDetails.deviceType	string	The type of device used.
Device Token	folder.envelopePartyPermissions.partyDetails.deviceToken	string	The push notification token for the device.
Subcontractor Description	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	A description of the subcontractor or external signer.
Subcontractor Organization	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	The organization name of the subcontractor or external signer.
Subcontractor Added Date	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	The date the subcontractor was added (Unix timestamp in milliseconds).
Source	folder.envelopePartyPermissions.partyDetails.source	string	The source system from which the external signer was added.
Dialing Code	folder.envelopePartyPermissions.dialingCode	string	The international dialing code for the phone number.
Mobile Number	folder.envelopePartyPermissions.mobileNumber	string	The mobile phone number.
Signature Type	folder.envelopePartyPermissions.signerSignatureType	string	The type of signature the signer will use.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	The permissions granted to this party for the contract.
Signing Order	folder.envelopePartyPermissions.partySequence	integer	The signing order sequence number for this recipient.
Workflow Sequence	folder.envelopePartyPermissions.workflowSignSequence	integer	The workflow signing sequence number.
Envelope ID	folder.envelopePartyPermissions.envelopeId	integer	The unique identifier of the envelope.
Recipient Company ID	folder.envelopePartyPermissions.partyCompanyId	integer	The unique identifier of the company associated with this recipient.
Sharing Mode	folder.envelopePartyPermissions.sharingMode	string	The sharing mode for this envelope.
Recipient Access URL	folder.envelopePartyPermissions.folderAccessURL	string	The URL the recipient can use to access and sign the envelope.
Security Mode	folder.envelopePartyPermissions.securityMode	string	The security mode applied to this envelope.
Comments	folder.envelopePartyPermissions.extraComments	string	Additional comments included with the envelope.
Allow Name Change	folder.envelopePartyPermissions.allowNameChange	boolean	Indicates whether the recipient is allowed to update their name.
Name Updated	folder.envelopePartyPermissions.signerNameUpdated	boolean	Indicates whether the signer has updated their name.
Signer Auth Level	folder.envelopePartyPermissions.signerAuthenticationLevel	string	The authentication level required for the signer.
Access Code	folder.envelopePartyPermissions.userDefinedAccessCode	string	A custom access code defined for the signer.
Signature ID	folder.envelopePartyPermissions.signatureId	string	The unique identifier of the signature.
Recipient Role	folder.envelopePartyPermissions.partyRole	string	The role assigned to this recipient in the signing workflow.
Company Field	folder.envelopePartyPermissions.companyFieldValue	string	The value of the company name field in the signature.
Title Field	folder.envelopePartyPermissions.titleFieldValue	string	The value of the title field in the signature.
Reason for Signing	folder.envelopePartyPermissions.reasonSigning	string	The reason the recipient is signing the document.
Payment Field Added	folder.envelopePartyPermissions.payFieldAdded	boolean	Indicates whether a payment field has been added.
Payee	folder.envelopePartyPermissions.payee	boolean	Indicates whether this recipient is the payee.
Recurring Payment	folder.envelopePartyPermissions.recurringFieldExist	boolean	Indicates whether a recurring payment field exists.
Print and Sign Done	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Indicates whether the print-and-sign process is complete.
Paid	folder.envelopePartyPermissions.paid	boolean	Indicates whether payment has been completed.
Auth Level	folder.envelopeAuthenticationLevel	string	The authentication level required for the envelope.
Single Signer Bulk	folder.allowSingleSignerInBulk	boolean	Indicates whether a single signer is allowed in bulk send mode.
File-Based Naming	folder.folderNameBasedOnFileNaming	boolean	Indicates whether the folder name is based on the file name.
Doc File-Based Name	folder.documentNameBasedOnFileNaming	boolean	Indicates whether the document name is based on the file name.
Cert File-Based Name	folder.certificateNameBasedOnFileNaming	boolean	Indicates whether the certificate name is based on the file name.
Pre-Exec File Naming	folder.enableFileNamingBeforeExecution	boolean	Indicates whether file naming is enabled before document execution.
Payee Added	folder.payeeAddedd	boolean	Indicates whether a payee has been added.
Self-Signing Enabled	folder.selfSignerEnabled	boolean	Indicates whether self-signing mode is enabled.
Notary Enabled	folder.notaryEnabled	boolean	Indicates whether notary signing is enabled.
Limited Visibility	folder.limitedVisibilityFlag	boolean	Indicates whether limited visibility is enabled for this envelope.
Post-Sign Visibility	folder.postSigningVisibility	boolean	Indicates whether post-signing visibility is enabled.
Wet Signature	folder.wetSignatureEnabled	boolean	Indicates whether wet signatures are enabled.
Merge Enabled	folder.mergeEnabled	boolean	Indicates whether document merging is enabled.
Embedded Signing Sessions	embeddedSigningSessions	array of object	The list of embedded signing sessions, one per recipient. Only present when createEmbeddedSigningSession is true.
Signer Email	embeddedSigningSessions.emailIdOfSigner	string	The email address of the recipient for this embedded signing session.
Signing Token	embeddedSigningSessions.embeddedToken	string	The unique token for this recipient's embedded signing session.
Signing Session URL	embeddedSigningSessions.embeddedSessionURL	string	The URL to open or embed for this recipient to sign the document.
Embedded Sending Token	embeddedToken	string	The token for the embedded sending session. Only present when createEmbeddedSendingSession is true.
Sending Session URL	embeddedSessionURL	string	The URL to open or embed for the envelope author to prepare and send the envelope. Only present when createEmbeddedSendingSession is true.
Result	result	string	The result of the operation.
Message	message	string	A message describing the result of the operation.

Create Template from Base64

Operation ID:: CreateTemplatefromBase64

Creates a new template using a Base64-encoded PDF string. Use this when your PDF file is already available as a Base64 string in your flow, for example from a SharePoint file or OneDrive document.

Parameters

Name	Key	Required	Type	Description
Template Name	templateName	True	string	The name for the template. Must end with the .pdf extension (e.g., onboarding.pdf).
Base64 File String	base64FileString	True	string	BASE64 string of a PDF for the template creation. It should be publicly accessible when you are creating the template.
Input Type	inputType	True	string	The input method for the document. Always set to 'base64' for this action.
Process Text Tags	processTextTags	True	boolean	When enabled, Foxit eSign will scan the document for Text Tags and automatically convert them into signature fields.
Process Acro Fields	processAcroFields	True	boolean	When enabled, Foxit eSign will scan the document for AcroFields and automatically convert them into signature fields.
Share All	shareAll	True	boolean	Share this template with all users in your account.
Number Of Parties	numberOfParties	True	integer	The number of recipient parties for this template. Must be less than 20.
Theme Color	themeColor		string	A CSS color value to customise the theme of the embedded template session (e.g., #42caf4).
Author Email	authorEmail		string	The email address of another user in the account to be set as the author of this template.
Create Embedded Template Session	createEmbeddedTemplateSession		boolean	If set to true, an embedded template session is created so you can open the Foxit eSign template editor directly and drag and drop fields onto the template.
Redirect URL	redirectURL		string	If Create Embedded Template Session is true, the URL to redirect the user to after they click Save and Close in the embedded template editor.
Hide Send Template	hideSendTemplate		boolean	If true, the Send button is hidden in the embedded template editor.
Fix Recipient Parties	fixRecipientParties		boolean	If true, the recipient parties already added cannot be changed in the embedded template editor.
Fields	Fields		object
permissions	permission	True	string
Sequence	sequence	True	integer	A unique sequence number for this party, starting from 1. Defines the signing order when Sign In Sequence is enabled.
Recipient Role	partyRole	True	string	The role assigned to this party in the template.
Hide More Action	hideMoreAction		boolean	If true, the More Actions button is hidden in the embedded template session.
Hide Share With All	hideShareWithAll		boolean	If true, the Share with All option is hidden in the embedded template session.
Hide Add Party	hideAddParty		boolean	If true, all add party options are hidden in the embedded template session.
Hide Me Button	hideMeButton		boolean	If true, the Me button on Recipient Parties is hidden in the embedded template session.
Hide Others Button	hideOthersButton		boolean	If true, the Others button on Recipient Parties is hidden in the embedded template session.
Hide Field Name For Recipients	hideFieldNameForRecipients		boolean	If true, field names are hidden from recipients for data entry and advanced fields.
Hide Checkbox Border	hideCheckboxBorder		boolean	If true, checkbox borders are hidden in the executed documents.

Returns

Name	Path	Type	Description
Result	result	string	Indicates whether the operation succeeded (e.g., 'success').
Message	message	string	A description of the operation outcome.
ID	template.templateId	integer	The unique ID of the created template. Use this to create envelopes from this template.
Name	template.templateName	string	The name of the template.
Description	template.templateDesc	string	A description of the template.
Type	template.templateType	string	The type of the template.
Creation Date	template.templateCreationDate	string	The date the template was created.
Last Updated Date	template.templateLastUpdateDate	string	The date the template was last updated.
Editable	template.editable	boolean	Indicates whether the template can be edited.
Number of Parties	template.numberOfParties	integer	The number of recipient parties defined in the template.
Total Pages	template.totalPages	integer	The total number of pages in the template document.
Company ID	template.companyId	integer	The ID of the company this template belongs to.
Shared with All	template.shareAll	boolean	Indicates whether this template is shared with all users in the account.
Party Permissions	template.templatePartyPermissions	array of object	The list of recipient roles and their permissions defined in this template.
Party ID	template.templatePartyPermissions.template_party_id	integer	The unique ID of this template party entry.
ID	template.templatePartyPermissions.templateId	integer	The ID of the template this party belongs to.
Permissions	template.templatePartyPermissions.templatePermissions	string	The signing permissions for this party (e.g., FILL_FIELDS_AND_SIGN).
Signing Order	template.templatePartyPermissions.partySequence	integer	The signing order position for this party.
Party Role	template.templatePartyPermissions.templatePartyRole	string	The role name assigned to this party in the template. Use this when creating an envelope from the template.
User ID	template.templateCreatedBy.partyId	integer	The unique ID of the user.
First Name	template.templateCreatedBy.firstName	string	The user's first name.
Last Name	template.templateCreatedBy.lastName	string	The user's last name.
Email	template.templateCreatedBy.emailId	string	The user's email address.
Template Fields	allfields	array of object	The list of all signature and form fields defined in the template.
Field ID	allfields.fieldTagId	integer	The unique identifier of the field.
Template ID	allfields.templateId	integer	The ID of the template this field belongs to.
Company ID	allfields.companyId	integer	The company account this field belongs to.
Field Type	allfields.fieldType	string	The type of the field (e.g., signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Page Number	allfields.documentPageNumber	integer	The page number of the document where this field is placed.
Responsible Party	allfields.partyResponsible	integer	The party sequence number responsible for filling this field.
Party Sequence	allfields.partyResponsibleSequence	integer	The sequence position of the responsible party.
Field Doc ID	allfields.docFieldId	string	The document-level identifier for this field.
Is Dependent	allfields.dependent	boolean	Indicates whether this field's visibility depends on another field's value.
Tab Order	allfields.tabOrder	integer	The tab order for navigating between fields.
Required	allfields.required	boolean	Indicates whether this field must be filled before the document can be signed.
Custom Field Name	allfields.customFieldName	string	A custom name assigned to this field.
Share All	allfields.shareAll	boolean	Indicates whether this field is shared with all users.
Allow Edit	allfields.allowEdit	boolean	Indicates whether this field can be edited by the recipient.
Text Field Name	allfields.textfieldName	string	The label of the text field (applicable when fieldType is 'textfield').
Value	allfields.value	string	The pre-filled or entered value of the field.
Font Size	allfields.fontSize	integer	The font size used for text in this field.
Font Color	allfields.fontColor	string	The font colour used for text in this field (e.g., #000000).
Read Only	allfields.readOnly	boolean	Indicates whether the field is read-only and cannot be edited by the recipient.
Multi Line	allfields.multiLine	boolean	Indicates whether the text field accepts multiple lines of input (applicable when fieldType is 'textfield').
Character Limit	allfields.characterLimit	integer	The maximum number of characters allowed in the field (applicable when fieldType is 'textfield').
Date Field Name	allfields.datefieldName	string	The label of the date field (applicable when fieldType is 'datefield').
Date Format	allfields.dateFormat	string	The date format used by this field (e.g., MM/DD/YYYY) (applicable when fieldType is 'datefield').
Checkbox Name	allfields.cbname	string	The label of the checkbox field (applicable when fieldType is 'checkboxfield').
Checkbox Group	allfields.cbgroup	string	The group name for this checkbox (applicable when fieldType is 'checkboxfield').
Checked	allfields.checked	boolean	Indicates whether the checkbox is checked by default (applicable when fieldType is 'checkboxfield').
Secured Field Name	allfields.securedfieldName	string	The label of the secured field (applicable when fieldType is 'securedfield').
Chars To Display	allfields.charToDisplay	integer	The number of unmasked characters to display at the end of a secured field value (applicable when fieldType is 'securedfield').
Signature ID	allfields.signatureId	string	The ID of the signature applied to this sign field (applicable when fieldType is 'signfield').
Initial Image	allfields.initialImage	string	The image data for the initials applied to this field (applicable when fieldType is 'initialfield').
Attachment Field Name	allfields.attachmentfieldName	string	The name of the attachment field (applicable when fieldType is 'attachmentfield').
Attachment Description	allfields.attachmentfieldDescription	string	A description of what to attach (applicable when fieldType is 'attachmentfield').

Create Template from URL

Operation ID:: CreateTemplatefromURL

Creates a new template using a publicly accessible PDF URL.

Parameters

Name	Key	Required	Type	Description
Template Name	templateName	True	string	The name for the template. Must end with the .pdf extension (e.g., onboarding.pdf).
Template URL	templateUrl	True	string	The publicly accessible URL of the PDF document to use as the template.
Input Type	inputType	True	string	The input method for the document. Always set to 'url' for this action.
Process Text Tags	processTextTags	True	boolean	When enabled, Foxit eSign will scan the document for Text Tags and automatically convert them into signature fields.
Process Acro Fields	processAcroFields	True	boolean	When enabled, Foxit eSign will scan the document for AcroFields and automatically convert them into signature fields.
Share All	shareAll	True	boolean	Share this template with all users in your account.
Number Of Parties	numberOfParties	True	integer	Add number of parties in the template. The values of this parameter should be less than 20.
Theme Color	themeColor		string	Enter a css value for a color to change the theme of createEmbeddedTemplateSession .
Author Email	authorEmail		string	Enter email of another user in an account which will be used as the author for this template.
Create Embedded Template Session	createEmbeddedTemplateSession		boolean	If set as true, an embedded template session to directly open the Foxit eSign template preparing view. Dragging and dropping various fields on the template will be available.
Redirect Url	redirectURL		string	If createEmbeddedTemplateSession is true, the absolute URL can be entered for the landing page on any website/application, which the user will be redirected to after clicking "save and close" in the embedded template view.
Hide Send Template	hideSendTemplate		boolean	If true, it will hide the Send button in an embedded template view.
Fix Recipient Parties	fixRecipientParties		boolean	If true, then in the embedded template view cannot change the parties for the envelope which are already added.
Fields	Fields		object
permissions	permission	True	string
Sequence	sequence	True	integer	A unique sequence number for this party, starting from 1. Defines the signing order when Sign In Sequence is enabled.
Recipient Role	partyRole	True	string	The role assigned to this party in the template.
Hide More Action	hideMoreAction		boolean	If true, it will hide "More Actions" button in template session.
Hide Share With All	hideShareWithAll		boolean	If true, it will hide "Share with All" option in template session.
Hide Add Party	hideAddParty		boolean	If true, it will hide all add party's options in an embedded template session.
Hide Me Button	hideMeButton		boolean	If true, it will hide the "Me" button on Recipient Parties in an embedded template session.
Hide Others Button	hideOthersButton		boolean	If true, it will hide the "Others" button on Recipient Parties in an embedded template session.
Hide Existing Contact Select Option	hideExistingContactSelectOption		boolean	If true, it will hide the "Find and Add Existing Contact" input box on Recipient Parties in an embedded template session.
Hide Field Name For Recipients	hideFieldNameForRecipients		boolean	Hide field names for Recipients for Data Entry Fields and Advanced Fields.(Except Radio button, Checkbox, Image and Hyperlink).
Hide Checkbox Border	hideCheckboxBorder		boolean	Borders of Checkbox will be hidden in the executed documents.

Returns

Name	Path	Type	Description
Result	result	string	Indicates whether the operation succeeded (e.g., 'success').
Message	message	string	A description of the operation outcome.
ID	template.templateId	integer	The unique ID of the created template. Use this to create envelopes from this template.
Name	template.templateName	string	The name of the template.
Description	template.templateDesc	string	A description of the template.
Type	template.templateType	string	The type of the template.
Creation Date	template.templateCreationDate	string	The date the template was created.
Last Updated Date	template.templateLastUpdateDate	string	The date the template was last updated.
Editable	template.editable	boolean	Indicates whether the template can be edited.
Number of Parties	template.numberOfParties	integer	The number of recipient parties defined in the template.
Total Pages	template.totalPages	integer	The total number of pages in the template document.
Company ID	template.companyId	integer	The ID of the company this template belongs to.
Shared with All	template.shareAll	boolean	Indicates whether this template is shared with all users in the account.
Custom Name Pattern	template.templateCustomName	string	The custom name pattern applied to envelopes created from this template.
Party Permissions	template.templatePartyPermissions	array of object	The list of recipient roles and their permissions defined in this template.
Party ID	template.templatePartyPermissions.template_party_id	integer	The unique ID of this template party entry.
ID	template.templatePartyPermissions.templateId	integer	The ID of the template this party belongs to.
Permissions	template.templatePartyPermissions.templatePermissions	string	The signing permissions for this party (e.g., FILL_FIELDS_AND_SIGN).
Signing Order	template.templatePartyPermissions.partySequence	integer	The signing order position for this party.
Party Role	template.templatePartyPermissions.templatePartyRole	string	The role name assigned to this party in the template. Use this when creating an envelope from the template.
Party ID	template.templatePartyPermissions.partyId	integer	The ID of the party assigned to this role, if pre-assigned.
User ID	template.templateCreatedBy.partyId	integer	The unique ID of the user.
First Name	template.templateCreatedBy.firstName	string	The user's first name.
Last Name	template.templateCreatedBy.lastName	string	The user's last name.
Email	template.templateCreatedBy.emailId	string	The user's email address.
Company ID	template.templateCreatedBy.companyId	integer	The ID of the company the user belongs to.
User Role	template.templateCreatedBy.userRole	string	The user's role within their organisation.
Active	template.templateCreatedBy.active	boolean	Indicates whether the user's account is active.
User ID	template.templateLastUpdatedBy.partyId	integer	The unique ID of the user.
First Name	template.templateLastUpdatedBy.firstName	string	The user's first name.
Last Name	template.templateLastUpdatedBy.lastName	string	The user's last name.
Email	template.templateLastUpdatedBy.emailId	string	The user's email address.
Company ID	template.templateLastUpdatedBy.companyId	integer	The ID of the company the user belongs to.
User Role	template.templateLastUpdatedBy.userRole	string	The user's role within their organisation.
Active	template.templateLastUpdatedBy.active	boolean	Indicates whether the user's account is active.
Template Fields	allfields	array of object	The list of all signature and form fields defined in the template.
Field ID	allfields.fieldTagId	integer	The unique identifier of the field.
Template ID	allfields.templateId	integer	The ID of the template this field belongs to.
Company ID	allfields.companyId	integer	The company account this field belongs to.
Field Type	allfields.fieldType	string	The type of the field (e.g., signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Page Number	allfields.documentPageNumber	integer	The page number of the document where this field is placed.
Responsible Party	allfields.partyResponsible	integer	The party sequence number responsible for filling this field.
Party Sequence	allfields.partyResponsibleSequence	integer	The sequence position of the responsible party.
Field Doc ID	allfields.docFieldId	string	The document-level identifier for this field.
Is Dependent	allfields.dependent	boolean	Indicates whether this field's visibility depends on another field's value.
Tab Order	allfields.tabOrder	integer	The tab order for navigating between fields.
Required	allfields.required	boolean	Indicates whether this field must be filled before the document can be signed.
Custom Field Name	allfields.customFieldName	string	A custom name assigned to this field.
Share All	allfields.shareAll	boolean	Indicates whether this field is shared with all users.
Allow Edit	allfields.allowEdit	boolean	Indicates whether this field can be edited by the recipient.
Text Field Name	allfields.textfieldName	string	The label of the text field (applicable when fieldType is 'textfield').
Value	allfields.value	string	The pre-filled or entered value of the field.
Font Size	allfields.fontSize	integer	The font size used for text in this field.
Font Color	allfields.fontColor	string	The font colour used for text in this field (e.g., #000000).
Read Only	allfields.readOnly	boolean	Indicates whether the field is read-only and cannot be edited by the recipient.
Multi Line	allfields.multiLine	boolean	Indicates whether the text field accepts multiple lines of input (applicable when fieldType is 'textfield').
Character Limit	allfields.characterLimit	integer	The maximum number of characters allowed in the field (applicable when fieldType is 'textfield').
Date Field Name	allfields.datefieldName	string	The label of the date field (applicable when fieldType is 'datefield').
Date Format	allfields.dateFormat	string	The date format used by this field (e.g., MM/DD/YYYY) (applicable when fieldType is 'datefield').
Checkbox Name	allfields.cbname	string	The label of the checkbox field (applicable when fieldType is 'checkboxfield').
Checkbox Group	allfields.cbgroup	string	The group name for this checkbox (applicable when fieldType is 'checkboxfield').
Checked	allfields.checked	boolean	Indicates whether the checkbox is checked by default (applicable when fieldType is 'checkboxfield').
Secured Field Name	allfields.securedfieldName	string	The label of the secured field (applicable when fieldType is 'securedfield').
Chars To Display	allfields.charToDisplay	integer	The number of unmasked characters to display at the end of a secured field value (applicable when fieldType is 'securedfield').
Signature ID	allfields.signatureId	string	The ID of the signature applied to this sign field (applicable when fieldType is 'signfield').
Initial Image	allfields.initialImage	string	The image data for the initials applied to this field (applicable when fieldType is 'initialfield').
Attachment Field Name	allfields.attachmentfieldName	string	The name of the attachment field (applicable when fieldType is 'attachmentfield').
Attachment Description	allfields.attachmentfieldDescription	string	A description of what to attach (applicable when fieldType is 'attachmentfield').

Delete Envelopes

Operation ID:: DeleteEnvelopes

Permanently deletes one or more envelopes.

Parameters

Name	Key	Required	Type	Description
Folder Ids	folderIds	True	array of integer	An array of envelope IDs to act on.

Returns

Name	Path	Type	Description
Result	result	string	Indicates whether the operation succeeded.

Download Envelope Files

Operation ID:: DownloadEnvelopeFiles

Downloads the completed documents from an envelope as a file.

Parameters

Name	Key	Required	Type	Description
Envelope ID	folderId	True	string	The unique identifier of the envelope whose documents you want to download.

Returns

response: binary

Download Report

Operation ID:: DownloadReport

Downloads an envelope activity report as a Microsoft Excel file. Use the filters to narrow results by status, date range, envelope name, author, or signer.

Parameters

Name	Key	Type	Description
envelopeStatus	status	string	The statuses of the folder by which we will filter a report
Creation Date From	creationDateFrom	string	Start of the Creation Date range. Accepted format: YYYY-MM-DD.
Creation Date To	creationDateTo	string	End of the Creation Date range. Accepted format: YYYY-MM-DD.
Envelope Name	folderName	string	Any folder which contains this string.
Include Fields	includeFields	string	Set to 'true' to include envelope field values in the report. Defaults to 'false'.
Author Email	authorEmail	string	Filter the report to only include envelopes created by this author email address.
Signer Email	signerEmail	string	Filter the report to only include envelopes where this email address is a signer.

Returns

Report File: binary

Download Single Document PDF

Operation ID:: DownloadSingleDocumentPDF

Downloads a single document from an envelope as a PDF file.

Parameters

Name	Key	Required	Type	Description
Envelope ID	folderId	True	string	The unique identifier of the envelope containing the document to download.
Document Number	docNumber	True	string	The index of the document to download, starting from 1.

Returns

response: binary

Get a list of all Templates

Operation ID:: GetalistofallTemplates

Returns a list of all templates available in your account.

Returns

Name	Path	Type	Description
Result	result	string	Indicates whether the request was successful.
Total Templates	total_templates	integer	The total number of templates in your account.
Templates List	templatesList	array of object	The list of all templates available in the account.
Template ID	templatesList.templateId	integer	The unique identifier of the template. Use this ID with Create Envelope from Template to send the template for signing.
Template Name	templatesList.templateName	string	The name of the template.
Template Description	templatesList.templateDesc	string	A description of the template.
Template Type	templatesList.templateType	string	The type or category of the template.
Created Date	templatesList.templateCreationDate	integer	The date the template was created, in Unix milliseconds.
Last Updated Date	templatesList.templateLastUpdateDate	integer	The date the template was last updated, in Unix milliseconds.
Editable	templatesList.editable	boolean	Indicates whether the template can be edited.
Number of Parties	templatesList.numberOfParties	integer	The number of signing parties defined in the template.
Company ID	templatesList.companyId	integer	The company account the template belongs to.
Share With All	templatesList.shareAll	boolean	Indicates whether the template is shared with all users in the account.
Party ID	templatesList.templateCreatedBy.partyId	integer	The unique identifier of the user.
First Name	templatesList.templateCreatedBy.firstName	string	The first name of the user.
Last Name	templatesList.templateCreatedBy.lastName	string	The last name of the user.
Email	templatesList.templateCreatedBy.emailId	string	The email address of the user.
Party ID	templatesList.templateLastUpdatedBy.partyId	integer	The unique identifier of the user.
First Name	templatesList.templateLastUpdatedBy.firstName	string	The first name of the user.
Last Name	templatesList.templateLastUpdatedBy.lastName	string	The last name of the user.
Email	templatesList.templateLastUpdatedBy.emailId	string	The email address of the user.

Get Deleted Envelope History

Operation ID:: GetDeletedEnvelopeHistory

Retrieves a history of envelopes that have been deleted or moved to the recycle bin.

Parameters

Name	Key	Required	Type	Description
Envelope ID	folderId	True	string	The unique identifier of the envelope whose deletion history you want to retrieve.

Returns

Name	Path	Type	Description
Result	result	string	Indicates whether the request was successful.
Deleted Envelope Info	Deleted Folder Log Info	array of object	Summary information about the deleted envelope.
Envelope ID	Deleted Folder Log Info.folderId	integer	The unique identifier of the deleted envelope.
Envelope Name	Deleted Folder Log Info.folderName	string	The name of the deleted envelope.
Document Name	Deleted Folder Log Info.documentName	string	The name of the document in the deleted envelope.
Document ID	Deleted Folder Log Info.documentId	string	The unique identifier of the document in the deleted envelope.
Deletion Date	Deleted Folder Log Info.deletionDate	integer	The date and time the envelope was deleted, in Unix milliseconds.
Deleted By	Deleted Folder Log Info.deletedBy	string	The name of the user who deleted the envelope.
Deletion Log History	Deleted Folder Log History	array of object	The step-by-step log of all deletion actions performed on the envelope.
Performed By	Deleted Folder Log History.partiesName	string	The name of the user who performed the deletion step.
Source	Deleted Folder Log History.source	string	The source from which the deletion was initiated (e.g., Web, API).
Event	Deleted Folder Log History.event	string	The specific deletion action performed (e.g., Delete Folder, Delete All Parties From Folder).

Get Email Group Details

Operation ID:: GetEmailGroupDetails

Retrieves details of an existing email group.

Parameters

Name	Key	Required	Type	Description
Email Group Names	emailGroupNames	True	array of string	An array of email group names used to identify the groups.

Returns

Name	Path	Type	Description
Email Groups	allEmailGroups	array of object	The list of email groups matching the requested group names.
Group ID	allEmailGroups.groupId	integer	The unique identifier of the email group.
Group Name	allEmailGroups.groupName	string	The name of the email group.
Group Description	allEmailGroups.groupDesc	string	The description of the email group.
Date Created	allEmailGroups.dateCreated	integer	The date the email group was created, in Unix milliseconds.
Company ID	allEmailGroups.companyId	integer	The company account this email group belongs to.
Parties	allEmailGroups.parties	array of object	The list of recipients in this email group.
First Name	allEmailGroups.parties.firstName	string	The first name of the recipient.
Last Name	allEmailGroups.parties.lastName	string	The last name of the recipient.
Email	allEmailGroups.parties.emailId	string	The email address of the recipient.

Get Envelope Activity History

Operation ID:: GetEnvelopeActivityHistory

Retrieves a full activity log for an envelope, showing all actions taken by recipients and the sender.

Parameters

Name	Key	Required	Type	Description
Envelope ID	folderId	True	integer	The unique identifier of the envelope whose activity history you want to retrieve.

Returns

Name	Path	Type	Description
Result	result	string	Indicates whether the request was successful.
Envelope ID	details.folderId	integer	The unique identifier of the envelope.
Enclosed Documents	details.enclosedDocuments	string	The name of the document(s) enclosed in the envelope.
Recipients	details.envelopeRecipients	string	The names of all recipients on the envelope.
Author	details.author	string	The name of the user who created the envelope.
Status	details.status	string	The current status of the envelope (e.g., SHARED, EXECUTED, CANCELLED).
Latest Activity Date	details.latestActivityDate	string	The date and time of the most recent activity on the envelope.
Date Created	details.dateCreated	string	The date and time the envelope was created.
Date Sent	details.dateSent	string	The date and time the envelope was sent to recipients.
Activities	details.activities	array of object	The chronological list of all actions taken on this envelope.
Activity	details.activities.activity	string	A human-readable description of the action that occurred.
Action	details.activities.action	string	The type of action performed (e.g., Created, Invitation Sent, Opened, Viewed, Signed).
User	details.activities.user	string	The name of the user who performed the action.
Envelope Status	details.activities.folderStatus	string	The status of the envelope at the time this action occurred.
Time	details.activities.time	string	The date and time the action occurred.
Source	details.activities.source	string	The source from which the action was performed (e.g., Web).
IP Address	details.activities.ipAddress	string	The IP address from which the action was performed, if available.

Get Envelope Details

Operation ID:: GetEnvelopeDetails

Retrieves full details of an envelope, including its status, recipients, and documents.

Parameters

Name	Key	Required	Type	Description
Envelope ID	folderId	True	integer	The unique identifier of the envelope to retrieve.
Access Token	access_token		string	The OAuth 2.0 access token for authentication.

Returns

Name	Path	Type	Description
Result	result	string	Indicates whether the operation succeeded (e.g., 'success').
ID	folder.folderId	integer	The unique ID of the envelope.
Name	folder.folderName	string	The name of the envelope.
Author ID	folder.folderAuthorId	integer	The unique ID of the user who created the envelope.
Author First Name	folder.folderAuthorFirstName	string	The first name of the envelope creator.
Author Last Name	folder.folderAuthorLastName	string	The last name of the envelope creator.
Author Email	folder.folderAuthorEmail	string	The email address of the envelope creator.
Author Role	folder.folderAuthorRole	string	The account role of the envelope creator.
Company ID	folder.folderCompanyId	integer	The unique ID of the company the envelope belongs to.
Creation Date	folder.folderCreationDate	integer	The date and time the envelope was created, in Unix milliseconds.
Sent Date	folder.folderSentDate	integer	The date and time the envelope was sent to recipients, in Unix milliseconds. Null if not yet sent.
Status	folder.folderStatus	string	The current status of the envelope (e.g., SHARED, EXECUTED, DRAFT, CANCELLED).
Document IDs	folder.folderDocumentIds	array of integer	The list of document IDs included in this envelope.
Documents	folder.documentsList	array of object	Details of each document included in the envelope.
Document ID	folder.documentsList.documentId	integer	The unique identifier of the document.
Contract ID	folder.documentsList.contractId	integer	The unique identifier of the contract associated with this document.
Company ID	folder.documentsList.companyId	integer	The unique ID of the company this document belongs to.
Created By	folder.documentsList.contractCreatedBy	integer	The user ID of the person who created the contract.
Created On	folder.documentsList.contractCreatedOn	integer	The date the contract was created, in Unix milliseconds.
Contract Type	folder.documentsList.contractType	string	The type or category of the contract.
Document Status	folder.documentsList.contractStatus	string	The current signing status of the document (e.g., WAITING_FOR_SIGNATURE, EXECUTED).
Editable	folder.documentsList.editable	boolean	Indicates whether the document can be edited.
Version ID	folder.documentsList.contractVersionId	integer	The unique ID of the current document version.
Version Name	folder.documentsList.contractVersionName	string	The name of the current document version.
Version Description	folder.documentsList.contractVersionDesc	string	A description of the current document version.
Version Created By	folder.documentsList.versionCreatedby	integer	The user ID of the person who created this document version.
Version Created On	folder.documentsList.versionCreatedOn	integer	The date this document version was created, in Unix milliseconds.
Version Number	folder.documentsList.contractVersionNumber	integer	The version number of the document.
Recipients	folder.folderRecipientParties	array of object	The list of recipients for this envelope, including their signing status and access links.
Recipient ID	folder.folderRecipientParties.partyId	integer	The unique identifier of the recipient.
Recipient ID	folder.folderRecipientParties.partyDetails.partyId	integer	The unique identifier of the recipient.
First Name	folder.folderRecipientParties.partyDetails.firstName	string	The recipient's first name.
Last Name	folder.folderRecipientParties.partyDetails.lastName	string	The recipient's last name.
Email	folder.folderRecipientParties.partyDetails.emailId	string	The recipient's email address.
Address	folder.folderRecipientParties.partyDetails.address	string	The recipient's address.
Account Created Date	folder.folderRecipientParties.partyDetails.dateCreated	integer	The date the recipient's account was created, in Unix milliseconds.
Permissions	folder.folderRecipientParties.contractPermissions	string	The signing permissions granted to this recipient (e.g., FILL_FIELDS_AND_SIGN).
Signing Order	folder.folderRecipientParties.partySequence	integer	The position of this recipient in the signing order.
Workflow Sequence	folder.folderRecipientParties.workflowSignSequence	integer	The workflow signing sequence number for this recipient.
Envelope ID	folder.folderRecipientParties.envelopeId	integer	The ID of the envelope this recipient belongs to.
Sharing Mode	folder.folderRecipientParties.sharingMode	string	The method used to share the document with this recipient (e.g., email).
Signing URL	folder.folderRecipientParties.folderAccessURL	string	The unique signing URL for this recipient. Null if the envelope has already been completed or cancelled.
Security Mode	folder.folderRecipientParties.securityMode	string	The security mode applied to this recipient's access.
Extra Comments	folder.folderRecipientParties.extraComments	string	Any additional comments included in the signing invitation for this recipient.
Author Access URL	folder.folderAccessURLForAuthor	string	The URL for the envelope author to access the document. Null if not applicable.
Bulk ID	folder.bulkId	integer	The ID of the bulk send batch this envelope belongs to, if any.
Enforce Sign Order	folder.enforceSignWorkflow	boolean	Indicates whether recipients must sign in the specified order.
Current Workflow Step	folder.currentWorkflowStep	integer	The current step in the signing workflow.
Transaction Source	folder.transactionSource	string	The source that initiated this envelope transaction.
Editable	folder.editable	boolean	Indicates whether the envelope can still be edited.
In-Person Signing	folder.inPersonSignable	boolean	Indicates whether the envelope can be signed in person.
Override Reminders	folder.overrideAccountReminders	boolean	Indicates whether account-level reminder settings are overridden for this envelope.
ID	folder.envelopeId	integer	The unique ID of the envelope. Same value as Envelope ID (folderId).
Name	folder.envelopeName	string	The name of the envelope. Same value as Envelope Name (folderName).
Originator ID	folder.envelopeOriginatorId	integer	The user ID of the person who created the envelope.
Company ID	folder.envelopeCompanyId	integer	The ID of the company the envelope belongs to.
Date	folder.envelopeDate	integer	The date and time the envelope was created, in Unix milliseconds.
Shared Date	folder.envelopeSharedDate	integer	The date and time the envelope was shared with recipients, in Unix milliseconds. Null if not yet shared.
Status	folder.envelopeStatus	string	The current status of the envelope. Same value as Envelope Status (folderStatus).
Contract IDs	folder.envelopeContractIds	array of integer	The list of contract IDs associated with this envelope.
Party Permissions	folder.envelopePartyPermissions	array of object	The list of recipients and their signing permissions. Same structure as Recipients.
Recipient ID	folder.envelopePartyPermissions.partyId	integer	The unique identifier of the recipient.
First Name	folder.envelopePartyPermissions.partyDetails.firstName	string	The recipient's first name.
Last Name	folder.envelopePartyPermissions.partyDetails.lastName	string	The recipient's last name.
Email	folder.envelopePartyPermissions.partyDetails.emailId	string	The recipient's email address.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	The signing permissions for this recipient.
Signing Order	folder.envelopePartyPermissions.partySequence	integer	The position of this recipient in the signing order.
Signing URL	folder.envelopePartyPermissions.folderAccessURL	string	The unique signing URL for this recipient.
All Fields	allFields	array of object	The list of all signature and form fields placed in the envelope's documents.
Field ID	allFields.fieldTagId	integer	The unique identifier of the field.
Document ID	allFields.contractId	integer	The ID of the document this field belongs to.
Version ID	allFields.versionId	integer	The version ID of the document this field belongs to.
Field Type	allFields.fieldType	string	The type of the field (e.g., signfield, textfield, datefield, checkboxfield, dropdownfield, initialfield).
Page Number	allFields.documentPageNumber	integer	The page number where this field is placed.
Field Doc ID	allFields.docFieldId	string	The document-level identifier for this field.
Responsible Party	allFields.partyResponsible	integer	The party ID responsible for filling this field.
Is Dependent	allFields.dependent	boolean	Indicates whether this field's visibility depends on another field's value.
Required	allFields.required	boolean	Indicates whether this field must be filled before the document can be submitted.
Field Value	allFields.value	string	The current value of the field, if filled.
Field Values	allFieldsNameValue	array of object	A simplified list of all field names and their current values. Use this to read filled field data from a signed envelope.
Field ID	allFieldsNameValue.fieldId	integer	The unique identifier of the field.
Document ID	allFieldsNameValue.documentId	integer	The ID of the document this field belongs to.
Version ID	allFieldsNameValue.documentVersionId	integer	The version ID of the document this field belongs to.
Field Type	allFieldsNameValue.fieldType	string	The type of the field (e.g., textfield, signfield, datefield, checkboxfield, dropdownfield).
Field Name	allFieldsNameValue.name	string	The label or name of the field as defined in the template.
Field Value	allFieldsNameValue.value	string	The value entered or selected for this field.
Envelope History	Folder History	array of object	The audit trail of all actions taken on this envelope, in chronological order.
First Name	Folder History.firstName	string	The first name of the person who performed the action.
Last Name	Folder History.lastName	string	The last name of the person who performed the action.
Email	Folder History.email	string	The email address of the person who performed the action.
Envelope ID	Folder History.envelopeId	integer	The ID of the envelope on which the action was performed.
Date	Folder History.dateChanged	integer	The date and time the action occurred, in Unix milliseconds.
Party ID	Folder History.changeDoneByParty	integer	The party ID of the person who performed the action.
Action	Folder History.action	string	The action performed on the envelope (e.g., Created, InviteSentTo, InviteAccepted, Signed, Executed).

Get Envelope Ids

Operation ID:: GetEnvelopeIds

Returns a list of envelope IDs filtered by status. Use this to find envelopes in a specific state.

Parameters

Name	Key	Required	Type	Description
Date From	dateFrom	True	string	Start of the envelope creation date range. Accepted format: YYYY-MM-DD.
Date To	dateTo	True	string	End of the envelope creation date range. Accepted format: YYYY-MM-DD. The dateTo value must be within 6 months of the dateFrom value.
Status	status		string	Filter envelopes by status. Accepted values: EXECUTED, SHARED, DRAFT, PARTIALLY SIGNED, CANCELLED, EXPIRED, DELETED. If omitted, envelopes with any status are returned.

Returns

Name	Path	Type	Description
Result	result	string	Indicates whether the request was successful.
Message	message	string	A summary message indicating how many envelope IDs were returned.
Envelope IDs	allFolderIds	array of integer	The list of envelope IDs matching the filter criteria. Use these IDs with Get Envelope Details to retrieve full envelope information.

Get Template Details

Operation ID:: GetTemplateDetails

Retrieves the full details of a specific template, including its fields and recipients.

Parameters

Name	Key	Required	Type	Description
Template ID	templateId	True	string	The unique identifier of the template to retrieve.

Returns

Name	Path	Type	Description
Result	result	string	Indicates whether the request was successful.
ID	template.templateId	integer	The unique identifier of the template.
Name	template.templateName	string	The name of the template.
Description	template.templateDesc	string	A description of the template.
Type	template.templateType	string	The type of the template.
Created Date	template.templateCreationDate	integer	The date the template was created, in Unix milliseconds.
Last Updated Date	template.templateLastUpdateDate	integer	The date the template was last updated, in Unix milliseconds.
Editable	template.editable	boolean	Indicates whether the template can be edited.
Number of Parties	template.numberOfParties	integer	The number of signing parties defined in the template.
Total Pages	template.totalPages	integer	The total number of pages in the template document.
Company ID	template.companyId	integer	The company account the template belongs to.
Share With All	template.shareAll	boolean	Indicates whether the template is shared with all users in the account.
Custom Name Pattern	template.templateCustomName	string	The custom name pattern applied to envelopes created from this template.
Party Permissions	template.templatePartyPermissions	array of object	The list of recipient roles and their signing permissions defined in this template.
Party ID	template.templatePartyPermissions.template_party_id	integer	The unique ID of this template party entry.
ID	template.templatePartyPermissions.templateId	integer	The ID of the template this party belongs to.
Permissions	template.templatePartyPermissions.templatePermissions	string	The signing permissions for this party (e.g., FILL_FIELDS_AND_SIGN).
Signing Order	template.templatePartyPermissions.partySequence	integer	The signing order position for this party.
Party Role	template.templatePartyPermissions.templatePartyRole	string	The role name assigned to this party. Use this value when creating an envelope from this template.
Party ID	template.templatePartyPermissions.partyId	integer	The ID of the party assigned to this role, if pre-assigned.
Party ID	template.templateCreatedBy.partyId	integer	The unique identifier of the user.
First Name	template.templateCreatedBy.firstName	string	The first name of the user.
Last Name	template.templateCreatedBy.lastName	string	The last name of the user.
Email	template.templateCreatedBy.emailId	string	The email address of the user.
Department	template.templateCreatedBy.department	string	The department of the user.
Title	template.templateCreatedBy.title	string	The job title of the user.
Active	template.templateCreatedBy.active	boolean	Indicates whether the user account is active.
Party ID	template.templateLastUpdatedBy.partyId	integer	The unique identifier of the user.
First Name	template.templateLastUpdatedBy.firstName	string	The first name of the user.
Last Name	template.templateLastUpdatedBy.lastName	string	The last name of the user.
Email	template.templateLastUpdatedBy.emailId	string	The email address of the user.
Department	template.templateLastUpdatedBy.department	string	The department of the user.
Title	template.templateLastUpdatedBy.title	string	The job title of the user.
Active	template.templateLastUpdatedBy.active	boolean	Indicates whether the user account is active.
All Fields	allfields	array of object	The list of all fields defined in this template.
Field Tag ID	allfields.fieldTagId	integer	The unique identifier of the field.
Template ID	allfields.templateId	integer	The ID of the template this field belongs to.
Company ID	allfields.companyId	integer	The company account this field belongs to.
Field Type	allfields.fieldType	string	The type of the field (e.g., signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Page Number	allfields.documentPageNumber	integer	The page number of the document where this field is placed.
Party Responsible	allfields.partyResponsible	integer	The party sequence number responsible for completing this field.
Party Sequence	allfields.partyResponsibleSequence	integer	The sequence position of the responsible party.
Doc Field ID	allfields.docFieldId	string	The identifier of this field within the document.
Dependent	allfields.dependent	boolean	Indicates whether this field's visibility depends on another field's value.
Tab Order	allfields.tabOrder	integer	The tab order for navigating between fields.
Required	allfields.required	boolean	Indicates whether this field must be completed before the document can be signed.
Custom Field Name	allfields.customFieldName	string	A custom name assigned to this field.
Share All	allfields.shareAll	boolean	Indicates whether this field is shared with all users.
Allow Edit	allfields.allowEdit	boolean	Indicates whether this field can be edited by the recipient.
Text Field Name	allfields.textfieldName	string	The label of the text field (applicable when fieldType is 'textfield').
Value	allfields.value	string	The pre-filled or entered value of the field.
Font Size	allfields.fontSize	integer	The font size used for text in this field.
Font Color	allfields.fontColor	string	The font colour used for text in this field (e.g., #000000).
Read Only	allfields.readOnly	boolean	Indicates whether the field is read-only and cannot be edited by the recipient.
Multi Line	allfields.multiLine	boolean	Indicates whether the text field accepts multiple lines of input (applicable when fieldType is 'textfield').
Character Limit	allfields.characterLimit	integer	The maximum number of characters allowed in the field (applicable when fieldType is 'textfield').
Date Field Name	allfields.datefieldName	string	The label of the date field (applicable when fieldType is 'datefield').
Date Format	allfields.dateFormat	string	The date format used by this field (e.g., MM/DD/YYYY) (applicable when fieldType is 'datefield').
Checkbox Name	allfields.cbname	string	The label of the checkbox field (applicable when fieldType is 'checkboxfield').
Checkbox Group	allfields.cbgroup	string	The group name for this checkbox, used when multiple checkboxes are linked (applicable when fieldType is 'checkboxfield').
Checked	allfields.checked	boolean	Indicates whether the checkbox is checked by default (applicable when fieldType is 'checkboxfield').
Secured Field Name	allfields.securedfieldName	string	The label of the secured field (applicable when fieldType is 'securedfield').
Chars To Display	allfields.charToDisplay	integer	The number of unmasked characters to display at the end of a secured field value (applicable when fieldType is 'securedfield').
Signature ID	allfields.signatureId	string	The ID of the signature applied to this sign field (applicable when fieldType is 'signfield').
Initial Image	allfields.initialImage	string	The image data for the initials applied to this field (applicable when fieldType is 'initialfield').
Attachment Field Name	allfields.attachmentfieldName	string	The name of the attachment field (applicable when fieldType is 'attachmentfield').
Attachment Description	allfields.attachmentfieldDescription	string	A description of what to attach (applicable when fieldType is 'attachmentfield').

Get Templates by Template Ids

Operation ID:: GetTemplatesbyTemplateIds

Retrieves details for one or more templates by their IDs.

Parameters

Name	Key	Required	Type	Description
Template Ids	templateIds	True	array of integer	An array of template IDs to retrieve.

Returns

Name	Path	Type	Description
Result	result	string	Indicates whether the request was successful.
Total Templates	total_templates	integer	The total number of templates returned.
Template List	templateIdList	object	A map of template data keyed by template ID. Each entry contains the template details and its fields.

Get Webhook Channel Details

Operation ID:: GetWebhookChannelDetails

Retrieves the details of a specific webhook channel.

Parameters

Name	Key	Required	Type	Description
Channel ID	channelId	True	string	The unique identifier of the webhook channel to retrieve.

Returns

Name	Path	Type	Description
Result	result	string	Indicates whether the request was successful.
ID	channel.channelId	integer	The unique identifier of the webhook channel.
Company ID	channel.companyId	integer	The company account this channel belongs to.
Name	channel.channelName	string	The name of the webhook channel.
Webhook URL	channel.webhookUrl	string	The URL that Foxit eSign will call when a subscribed event occurs.
Webhook Secret	channel.webhookSecret	string	The secret key used to verify webhook payloads.
Date Created	channel.dateCreated	integer	The date the channel was created, in Unix milliseconds.
Date Updated	channel.dateUpdated	integer	The date the channel was last updated, in Unix milliseconds.
Webhook Level	channel.webhookLevel	string	The scope of the webhook channel. Either 'Account' (triggers for all envelopes) or 'API App' (triggers only for envelopes created via the API).
Status	channel.status	string	The current status of the channel. Either 'active' or 'deactive'.
Envelope Sent	channel.eventsSubscribedMap.folder_sent	boolean	Triggers when an envelope is sent to recipients.
Envelope Viewed	channel.eventsSubscribedMap.folder_viewed	boolean	Triggers when an envelope is opened by a recipient.
Envelope Signed	channel.eventsSubscribedMap.folder_signed	boolean	Triggers when an envelope is signed by a recipient.
Envelope Cancelled	channel.eventsSubscribedMap.folder_cancelled	boolean	Triggers when an envelope is cancelled.
Envelope Executed	channel.eventsSubscribedMap.folder_executed	boolean	Triggers when all parties have signed and the envelope is fully executed.
Envelope Deleted	channel.eventsSubscribedMap.folder_deleted	boolean	Triggers when an envelope is deleted.

List all Webhook Channels

Operation ID:: ListallWebhookChannels

Returns a list of all webhook channels configured in your account.

Returns

Name	Path	Type	Description
Result	result	string	Indicates whether the request was successful.
Total Channels	total_channel	integer	The total number of webhook channels configured in the account.
Webhook Channels	templatesList	array of object	The list of all webhook channels in the account.
Channel ID	templatesList.channelId	integer	The unique identifier of the webhook channel.
Company ID	templatesList.companyId	integer	The company account this channel belongs to.
Channel Name	templatesList.channelName	string	The name of the webhook channel.
Webhook URL	templatesList.webhookUrl	string	The URL that Foxit eSign will call when a subscribed event occurs.
Webhook Secret	templatesList.webhookSecret	string	The secret key used to verify webhook payloads.
Date Created	templatesList.dateCreated	integer	The date the channel was created, in Unix milliseconds.
Date Updated	templatesList.dateUpdated	integer	The date the channel was last updated, in Unix milliseconds.
Webhook Level	templatesList.webhookLevel	string	The scope of the webhook channel. Either 'Account' (triggers for all envelopes) or 'API App' (triggers only for envelopes created via the API).
Status	templatesList.status	string	The current status of the channel. Either 'active' or 'deactive'.
Envelope Sent	templatesList.eventsSubscribedMap.folder_sent	boolean	Triggers when an envelope is sent to recipients.
Envelope Viewed	templatesList.eventsSubscribedMap.folder_viewed	boolean	Triggers when an envelope is opened by a recipient.
Envelope Signed	templatesList.eventsSubscribedMap.folder_signed	boolean	Triggers when an envelope is signed by a recipient.
Envelope Cancelled	templatesList.eventsSubscribedMap.folder_cancelled	boolean	Triggers when an envelope is cancelled.
Envelope Executed	templatesList.eventsSubscribedMap.folder_executed	boolean	Triggers when all parties have signed and the envelope is fully executed.
Envelope Deleted	templatesList.eventsSubscribedMap.folder_deleted	boolean	Triggers when an envelope is deleted.

Move Envelopes to Recycle Bin

Operation ID:: MoveEnvelopestoRecycleBin

Moves one or more envelopes to the recycle bin. Envelopes in the recycle bin are not permanently deleted.

Parameters

Name	Key	Required	Type	Description
Folder Ids	folderIds	True	array of integer	An array of envelope IDs to act on.

Returns

Name	Path	Type	Description
Result	result	string	Indicates whether the operation succeeded.

Send Signature Reminder

Operation ID:: SendSignatureReminder

Sends a reminder notification to pending recipients of an envelope, prompting them to complete signing.

Parameters

Name	Key	Required	Type	Description
Envelope ID	folderId	True	integer	The ID of the envelope.

Returns

Name	Path	Type	Description
Result	result	string	Indicates whether the request was successful.
Envelope ID	reminder sent	integer	The ID of the envelope for which the reminder was sent.

Unsubscribe Webhook Trigger

Operation ID:: DeleteTriggerWebhookChannel

Deletes an active webhook channel subscription by its channel ID. Use this action to clean up webhook subscriptions that are no longer needed.

Parameters

Name	Key	Required	Type	Description
Channel ID	channelId	True	integer	The ID of the webhook channel to delete.

Triggers

When an envelope is cancelled	Triggers when an envelope is cancelled by a recipient or the sender.
When an envelope is deleted	Triggers when an envelope is deleted.
When an envelope is fully executed	Triggers when all recipients have signed and the envelope is fully executed.
When an envelope is sent	Triggers when an envelope is sent to recipients. This event only fires when Webhook Level is set to 'Account'.
When an envelope is signed	Triggers when a recipient signs the envelope.
When an envelope is viewed	Triggers when a recipient opens and views the envelope.

When an envelope is cancelled

Operation ID:: TriggerEnvelopeCancelled

Triggers when an envelope is cancelled by a recipient or the sender.

Parameters

Name	Key	Required	Type	Description
Channel Name	channelName	True	string	A name to identify this webhook subscription in your account.
Webhook Level	webhookLevel	True	string	Account: fires for all envelopes (web and API). API App: fires only for envelopes created via the API.
Webhook Secret	webhookSecret		string	Optional. Foxit eSign signs each webhook payload with HMAC-SHA-256 using this secret for verification.

Returns

The event data received from Foxit eSign when a webhook event fires.

WebhookEventPayload: WebhookEventPayload

When an envelope is deleted

Operation ID:: TriggerEnvelopeDeleted

Triggers when an envelope is deleted.

Parameters

Name	Key	Required	Type	Description
Channel Name	channelName	True	string	A name to identify this webhook subscription in your account.
Webhook Level	webhookLevel	True	string	Account: fires for all envelopes (web and API). API App: fires only for envelopes created via the API.
Webhook Secret	webhookSecret		string	Optional. Foxit eSign signs each webhook payload with HMAC-SHA-256 using this secret for verification.

Returns

The event data received from Foxit eSign when a webhook event fires.

WebhookEventPayload: WebhookEventPayload

When an envelope is fully executed

Operation ID:: TriggerEnvelopeExecuted

Triggers when all recipients have signed and the envelope is fully executed.

Parameters

Name	Key	Required	Type	Description
Channel Name	channelName	True	string	A name to identify this webhook subscription in your account.
Webhook Level	webhookLevel	True	string	Account: fires for all envelopes (web and API). API App: fires only for envelopes created via the API.
Webhook Secret	webhookSecret		string	Optional. Foxit eSign signs each webhook payload with HMAC-SHA-256 using this secret for verification.

Returns

The event data received from Foxit eSign when a webhook event fires.

WebhookEventPayload: WebhookEventPayload

When an envelope is sent

Operation ID:: TriggerEnvelopeSent

Triggers when an envelope is sent to recipients. This event only fires when Webhook Level is set to 'Account'.

Parameters

Name	Key	Required	Type	Description
Channel Name	channelName	True	string	A name to identify this webhook subscription in your account.
Webhook Level	webhookLevel	True	string	Account: fires for envelopes sent via web or API. API App: fires only for envelopes created via the API. The folder_sent event only fires at Account level.
Webhook Secret	webhookSecret		string	Optional. Foxit eSign signs each webhook payload with HMAC-SHA-256 using this secret for verification.

Returns

The event data received from Foxit eSign when a webhook event fires.

WebhookEventPayload: WebhookEventPayload

When an envelope is signed

Operation ID:: TriggerEnvelopeSigned

Triggers when a recipient signs the envelope.

Parameters

Name	Key	Required	Type	Description
Channel Name	channelName	True	string	A name to identify this webhook subscription in your account.
Webhook Level	webhookLevel	True	string	Account: fires for all envelopes (web and API). API App: fires only for envelopes created via the API.
Webhook Secret	webhookSecret		string	Optional. Foxit eSign signs each webhook payload with HMAC-SHA-256 using this secret for verification.

Returns

The event data received from Foxit eSign when a webhook event fires.

WebhookEventPayload: WebhookEventPayload

When an envelope is viewed

Operation ID:: TriggerEnvelopeViewed

Triggers when a recipient opens and views the envelope.

Parameters

Name	Key	Required	Type	Description
Channel Name	channelName	True	string	A name to identify this webhook subscription in your account.
Webhook Level	webhookLevel	True	string	Account: fires for all envelopes (web and API). API App: fires only for envelopes created via the API.
Webhook Secret	webhookSecret		string	Optional. Foxit eSign signs each webhook payload with HMAC-SHA-256 using this secret for verification.

Returns

The event data received from Foxit eSign when a webhook event fires.

WebhookEventPayload: WebhookEventPayload

Definitions

WebhookEventPayload

The event data received from Foxit eSign when a webhook event fires.

Name	Path	Type	Description
Event Name	event_name	string	The name of the event that fired (e.g., folder_sent, folder_signed, folder_executed).
Event Date	event_date	integer	The date and time the event occurred (Unix timestamp in milliseconds).
ID	data.folder.folderId	integer	The unique ID of the envelope.
Name	data.folder.folderName	string	The name of the envelope.
Custom Name	data.folder.folderCustomName	string	The custom name assigned to the envelope.
Password	data.folder.folderPassword	string	The access password for the envelope, if set.
Creator ID	data.folder.folderAuthorId	integer	The user ID of the envelope creator.
Creator First Name	data.folder.folderAuthorFirstName	string	The first name of the envelope creator.
Creator Last Name	data.folder.folderAuthorLastName	string	The last name of the envelope creator.
Creator Email	data.folder.folderAuthorEmail	string	The email address of the envelope creator.
Creator Role	data.folder.folderAuthorRole	string	The account role of the envelope creator.
Company ID	data.folder.folderCompanyId	integer	The company ID that owns the envelope.
Created Date	data.folder.folderCreationDate	integer	The date the envelope was created (Unix timestamp in milliseconds).
Sent Date	data.folder.folderSentDate	integer	The date the envelope was sent (Unix timestamp in milliseconds).
Status	data.folder.folderStatus	string	The current status of the envelope.
Custom Field 1	data.folder.custom_field1	string	The first custom metadata field.
Custom Field 2	data.folder.custom_field2	string	The second custom metadata field.
Metadata	data.folder.metadata	string	Custom metadata associated with the envelope.
Document IDs	data.folder.folderDocumentIds	array of integer	The list of document IDs in the envelope.
Documents	data.folder.documentsList	array of object	The list of documents in the envelope.
Document ID	data.folder.documentsList.documentId	integer	The unique identifier of the document.
Contract ID	data.folder.documentsList.contractId	integer	The contract ID for this document.
Company ID	data.folder.documentsList.companyId	integer	The company ID for this document.
Created By	data.folder.documentsList.contractCreatedBy	integer	The user ID of the person who created the contract.
Created On	data.folder.documentsList.contractCreatedOn	integer	The date the contract was created (Unix timestamp in milliseconds).
Contract Type	data.folder.documentsList.contractType	string	The type of the contract.
Contract Status	data.folder.documentsList.contractStatus	string	The current status of the contract.
Editable	data.folder.documentsList.editable	boolean	Indicates whether the document is editable.
Version ID	data.folder.documentsList.contractVersionId	integer	The version ID of the contract.
Version Name	data.folder.documentsList.contractVersionName	string	The name of the contract version.
Version Description	data.folder.documentsList.contractVersionDesc	string	A description of the contract version.
Version Created By	data.folder.documentsList.versionCreatedby	integer	The user ID of the person who created this version.
Version Created On	data.folder.documentsList.versionCreatedOn	integer	The date this version was created (Unix timestamp in milliseconds).
Version Number	data.folder.documentsList.contractVersionNumber	integer	The version number of the contract.
Transaction Source	data.folder.documentsList.contractTransactionSource	string	The source system that initiated the contract.
Recipients	data.folder.folderRecipientParties	array of object	The list of recipients for this envelope.
Recipient ID	data.folder.folderRecipientParties.partyId	integer	The unique identifier of the recipient.
Recipient ID	data.folder.folderRecipientParties.partyDetails.partyId	integer	The recipient's unique ID.
First Name	data.folder.folderRecipientParties.partyDetails.firstName	string	The recipient's first name.
Last Name	data.folder.folderRecipientParties.partyDetails.lastName	string	The recipient's last name.
Email	data.folder.folderRecipientParties.partyDetails.emailId	string	The recipient's email address.
Placeholder	data.folder.folderRecipientParties.partyDetails.placeholder	boolean	Whether this is a placeholder recipient.
Address	data.folder.folderRecipientParties.partyDetails.address	string	The recipient's address.
Date Created	data.folder.folderRecipientParties.partyDetails.dateCreated	integer	The date the recipient record was created (Unix timestamp in milliseconds).
Opt Out Emails	data.folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Whether the recipient has opted out of emails.
Unique ID	data.folder.folderRecipientParties.partyDetails.uniquePartyId	string	A unique system identifier for this recipient.
Auth Level	data.folder.folderRecipientParties.partyDetails.authenticationLevel	string	The authentication method for this recipient.
Password Updated Date	data.folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	The date the password was last updated.
Password Status	data.folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Whether the password has been updated.
Dialing Code	data.folder.folderRecipientParties.dialingCode	string	The international dialing code.
Mobile	data.folder.folderRecipientParties.mobileNumber	string	The recipient's mobile number.
Signature Type	data.folder.folderRecipientParties.signerSignatureType	string	The type of signature the signer will use.
Permissions	data.folder.folderRecipientParties.contractPermissions	string	The permissions granted to this recipient.
Signing Order	data.folder.folderRecipientParties.partySequence	integer	The signing order for this recipient.
Workflow Sequence	data.folder.folderRecipientParties.workflowSignSequence	integer	The workflow signing sequence number.
Envelope ID	data.folder.folderRecipientParties.envelopeId	integer	The envelope ID associated with this recipient.
Recipient Company ID	data.folder.folderRecipientParties.partyCompanyId	integer	The company ID of this recipient.
Sharing Mode	data.folder.folderRecipientParties.sharingMode	string	The sharing mode for this recipient.
Recipient Signing URL	data.folder.folderRecipientParties.folderAccessURL	string	The URL for this recipient to access and sign the envelope.
Security Mode	data.folder.folderRecipientParties.securityMode	string	The security mode for this recipient.
Comments	data.folder.folderRecipientParties.extraComments	string	Additional comments for the recipient.
Allow Name Change	data.folder.folderRecipientParties.allowNameChange	boolean	Whether the recipient can update their name.
Name Updated	data.folder.folderRecipientParties.signerNameUpdated	boolean	Whether the signer has updated their name.
Signer Auth Level	data.folder.folderRecipientParties.signerAuthenticationLevel	string	The authentication level required for the signer.
Access Code	data.folder.folderRecipientParties.userDefinedAccessCode	string	A custom access code for the signer.
Signature ID	data.folder.folderRecipientParties.signatureId	string	The ID of the applied signature.
Role	data.folder.folderRecipientParties.partyRole	string	The role of this recipient in the signing workflow.
Company Field	data.folder.folderRecipientParties.companyFieldValue	string	The company name field value.
Title Field	data.folder.folderRecipientParties.titleFieldValue	string	The title field value.
Reason for Signing	data.folder.folderRecipientParties.reasonSigning	string	The reason given for signing.
Payment Field Added	data.folder.folderRecipientParties.payFieldAdded	boolean	Whether a payment field was added.
Payee	data.folder.folderRecipientParties.payee	boolean	Whether this recipient is the payee.
Recurring Payment	data.folder.folderRecipientParties.recurringFieldExist	boolean	Whether a recurring payment field exists.
Print and Sign Done	data.folder.folderRecipientParties.printAndSignCompleted	boolean	Whether print-and-sign is complete.
Optional Signer	data.folder.folderRecipientParties.allowOptionalSigner	boolean	Whether this recipient is an optional signer.
Optional Signers	data.folder.folderRecipientParties.optionalSigners	array of integer	Optional signer party IDs.
Paid	data.folder.folderRecipientParties.paid	boolean	Whether payment has been completed.
Author Access URL	data.folder.folderAccessURLForAuthor	string	The URL for the envelope author to access the envelope.
Draft Access URL	data.folder.draftFolderAccessURL	string	The URL to access the envelope in draft state.
Boardroom Signing	data.folder.boardRoomSign	boolean	Whether boardroom signing mode is enabled.
Include Logo	data.folder.includeLogo	boolean	Whether the company logo is included in emails.
Button Background Color	data.folder.email_btnBgColor	string	The background color of the email action button.
Button Text Color	data.folder.email_btnTxtColor	string	The text color of the email action button.
Email Logo	data.folder.emailTemplateLogo	string	The logo URL used in the email template.
Email Template ID	data.folder.emailTemplateId	integer	The ID of the email template used.
Email Header	data.folder.emailHeader	string	The header text in notification emails.
Email Footer	data.folder.emailFooter	string	The footer text in notification emails.
Purge Scheduled	data.folder.purgeFlag	boolean	Whether the envelope is scheduled for purging.
Purge Start Date	data.folder.purgeStartDate	string	The start date for the purge schedule.
Purge End Date	data.folder.purgeEndDate	string	The end date for the purge schedule.
Bulk ID	data.folder.bulkId	integer	The bulk send operation ID, if applicable.
Enforce Sign Order	data.folder.enforceSignWorkflow	boolean	Whether recipients must sign in the defined order.
Current Workflow Step	data.folder.currentWorkflowStep	integer	The current step in the signing workflow.
Transaction Source	data.folder.transactionSource	string	The source system that initiated this transaction.
Editable	data.folder.editable	boolean	Whether the envelope is editable.
In-Person Signing	data.folder.inPersonSignable	boolean	Whether the envelope supports in-person signing.
Override Reminders	data.folder.overrideAccountReminders	boolean	Whether account-level reminder settings are overridden.
Override Delegation	data.folder.overrideAccountRecipientDelegation	boolean	Whether account-level delegation settings are overridden.
Allow Delegation	data.folder.allowRecipientsToDelegate	boolean	Whether recipients can delegate signing.
ID	data.folder.envelopeId	integer	The unique envelope ID (alias of folderId).
Name	data.folder.envelopeName	string	The envelope name (alias of folderName).
Originator ID	data.folder.envelopeOriginatorId	integer	The user ID who originated the envelope.
Company ID	data.folder.envelopeCompanyId	integer	The company ID that owns the envelope.
Date	data.folder.envelopeDate	integer	The date the envelope was created (Unix timestamp in milliseconds).
Shared Date	data.folder.envelopeSharedDate	integer	The date the envelope was shared (Unix timestamp in milliseconds).
Status	data.folder.envelopeStatus	string	The current status of the envelope.
Contract IDs	data.folder.envelopeContractIds	array of integer	The contract IDs associated with this envelope.
Party Permissions	data.folder.envelopePartyPermissions	array of object	The recipient permissions list (same structure as Recipients).
Recipient ID	data.folder.envelopePartyPermissions.partyId	integer	The unique identifier of the recipient.
Recipient ID	data.folder.envelopePartyPermissions.partyDetails.partyId	integer
First Name	data.folder.envelopePartyPermissions.partyDetails.firstName	string
Last Name	data.folder.envelopePartyPermissions.partyDetails.lastName	string
Email	data.folder.envelopePartyPermissions.partyDetails.emailId	string
Placeholder	data.folder.envelopePartyPermissions.partyDetails.placeholder	boolean
Address	data.folder.envelopePartyPermissions.partyDetails.address	string
Date Created	data.folder.envelopePartyPermissions.partyDetails.dateCreated	integer
Opt Out Emails	data.folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean
Unique ID	data.folder.envelopePartyPermissions.partyDetails.uniquePartyId	string
Auth Level	data.folder.envelopePartyPermissions.partyDetails.authenticationLevel	string
Password Updated Date	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string
Password Status	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean
Dialing Code	data.folder.envelopePartyPermissions.dialingCode	string
Mobile	data.folder.envelopePartyPermissions.mobileNumber	string
Signature Type	data.folder.envelopePartyPermissions.signerSignatureType	string
Permissions	data.folder.envelopePartyPermissions.contractPermissions	string
Signing Order	data.folder.envelopePartyPermissions.partySequence	integer
Workflow Sequence	data.folder.envelopePartyPermissions.workflowSignSequence	integer
Envelope ID	data.folder.envelopePartyPermissions.envelopeId	integer
Recipient Company ID	data.folder.envelopePartyPermissions.partyCompanyId	integer
Sharing Mode	data.folder.envelopePartyPermissions.sharingMode	string
Recipient Signing URL	data.folder.envelopePartyPermissions.folderAccessURL	string
Security Mode	data.folder.envelopePartyPermissions.securityMode	string
Comments	data.folder.envelopePartyPermissions.extraComments	string
Allow Name Change	data.folder.envelopePartyPermissions.allowNameChange	boolean
Name Updated	data.folder.envelopePartyPermissions.signerNameUpdated	boolean
Signer Auth Level	data.folder.envelopePartyPermissions.signerAuthenticationLevel	string
Access Code	data.folder.envelopePartyPermissions.userDefinedAccessCode	string
Signature ID	data.folder.envelopePartyPermissions.signatureId	string
Role	data.folder.envelopePartyPermissions.partyRole	string
Company Field	data.folder.envelopePartyPermissions.companyFieldValue	string
Title Field	data.folder.envelopePartyPermissions.titleFieldValue	string
Reason for Signing	data.folder.envelopePartyPermissions.reasonSigning	string
Payment Field Added	data.folder.envelopePartyPermissions.payFieldAdded	boolean
Payee	data.folder.envelopePartyPermissions.payee	boolean
Recurring Payment	data.folder.envelopePartyPermissions.recurringFieldExist	boolean
Print and Sign Done	data.folder.envelopePartyPermissions.printAndSignCompleted	boolean
Optional Signer	data.folder.envelopePartyPermissions.allowOptionalSigner	boolean
Optional Signers	data.folder.envelopePartyPermissions.optionalSigners	array of integer
Paid	data.folder.envelopePartyPermissions.paid	boolean
Auth Level	data.folder.envelopeAuthenticationLevel	string	The authentication level required for the envelope.
Single Signer Bulk	data.folder.allowSingleSignerInBulk	boolean	Whether a single signer is allowed in bulk mode.
File-Based Folder Name	data.folder.folderNameBasedOnFileNaming	boolean
File-Based Doc Name	data.folder.documentNameBasedOnFileNaming	boolean
File-Based Cert Name	data.folder.certificateNameBasedOnFileNaming	boolean
Pre-Exec File Naming	data.folder.enableFileNamingBeforeExecution	boolean
Payee Added	data.folder.payeeAddedd	boolean
Self-Signing Enabled	data.folder.selfSignerEnabled	boolean
Notary Enabled	data.folder.notaryEnabled	boolean
Limited Visibility	data.folder.limitedVisibilityFlag	boolean
Post-Sign Visibility	data.folder.postSigningVisibility	boolean
Wet Signature	data.folder.wetSignatureEnabled	boolean
Merge Enabled	data.folder.mergeEnabled	boolean

binary

This is the basic data type 'binary'.