Nitro Sign (Preview)

Nitro Sign API enables secure, end-to-end eSignature workflows by allowing applications to create, manage, and track digital signing processes. It provides capabilities to create envelopes, upload documents, add participants, define signing order, and send documents for signature via a fully automated, API-driven approach.

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	Nitro support
URL	https://www.gonitro.com/support
Email	prosupport@sfdc.gonitro.com

Connector Metadata
Publisher	Nitro PDF
Website	https://www.gonitro.com/
Privacy policy	https://www.gonitro.com/legal/privacy-policy
Categories	Productivity; IT operations

Nitro Sign Connector

Overview

The Nitro Sign connector enables secure, end-to-end eSignature workflows directly from Power Automate and Power Apps. It lets applications create and manage signing envelopes, upload and reorder documents, add participants and define signing order, place signature and data fields, send documents for signature, track progress, and download the original, sealed, and audit-trail files — all through a fully automated, API-driven approach.

Publisher: Nitro Software

Prerequisites

To use Nitro Sign through this connector, you will need:

A Nitro account with Nitro Sign enabled
https://developers.gonitro.com/
A Microsoft PowerApps or Power Automate plan with Custom Connector capabilities.

Authentication

Nitro Sign uses machine‑to‑machine OAuth 2.0 with the Client Credentials grant to generate access tokens for API requests.

How it works

You create an API application in Nitro’s self‑service portal and obtain the associated Client ID and Client Secret.
The connector authenticates by exchanging these credentials for a Bearer access token.
The token is then used to authorize subsequent Nitro Sign API calls.

Create credentials & read the detailed guide:
https://developers.gonitro.com/docs/authentication/credentials

Creating a connection in Power Automate / Power Apps

When adding the connector to a flow or app:

Click Add a new connection.
Enter your Client ID and Client Secret (issued in the Nitro developer portal).
Select your Nitro Region (Europe, United States or APAC) — the region associated with your Nitro account.
Save the connection — on first use, the connector exchanges your Client ID and Client Secret for a short-lived access token using the OAuth 2.0 Client Credentials grant, caches it, and renews it automatically. Your credentials are only used to obtain the token; subsequent API calls are authenticated with a bearer token on your behalf.

Note: No user-interactive sign-in is required; this flow is designed for server-to-server / app-to-app scenarios.

Supported Operations

The connector groups its actions around the four resources of a signing workflow — Envelopes, Documents, Fields, and Participants — plus a set of Download actions for retrieving finished files.

1. Envelopes

An envelope is the container for the documents, participants, and fields in a single signing request.

List Envelopes
Returns all envelopes associated with the application in the account. Results are paginated: the response includes a Next Page cursor token, which you can supply to the optional Page After parameter to retrieve the next page (or Page Before to page backwards). Both cursor parameters are under Advanced and are only needed when walking through large result sets.
Create Envelope
Creates a new envelope with a name, notification message (subject + body, with dynamic variables such as $(sender_name_or_email) and $(envelope_name)), and signing mode:
- parallel — all participants are notified at the same time and can sign independently.
- sequential — participants are notified one at a time, in the order they were added.
Get Envelope by ID
Retrieves details for a specific envelope by its UUID.
Update Envelope
Updates the envelope name, notification settings, and/or signing mode. All fields are optional.
Delete Envelope by ID
Permanently deletes an envelope and all associated documents, fields, and participants. This cannot be undone.
Send Envelope for Signing
Sends the envelope to participants for signature collection. Before sending, the envelope should normally have its documents, participants, and signing fields added (via Create Document by Envelope ID, Create Participant(s) by Envelope ID, and Create Field(s) by Document ID). All documents in the envelope must have an uploaded status before the envelope can be sent.
Send Reminders for Envelope
Triggers reminder notifications to pending participants. If no notification settings are provided, the default notification template configured for the envelope is used.
Cancel Envelope by ID
Cancels the signing request. Only envelopes that have already been sent for signing can be cancelled.

2. Documents

Documents are the files attached to an envelope and signed by participants.

List Documents by Envelope ID
Retrieves all documents associated with an envelope.
Create Document by Envelope ID
Uploads a document to an existing envelope. Supply the file plus simple, typed fields — no hand-written JSON:
- Document File — the file to upload.
- Document Name — the name to store the document under.
- Content Type (advanced, optional) — the file's MIME type; defaults to application/pdf. When omitted, only PDF files are accepted.
Get Document by ID
Retrieves details for a specific document in an envelope.
Update Document by ID
Updates document metadata. Currently, only the document name can be changed.
Delete Document by ID
Permanently deletes a document from an envelope.
Reorder Documents by Envelope ID
Reorders the documents in an envelope based on a supplied list of document IDs.

3. Fields

Fields are the interactive elements (signature, initials, date, etc.) placed on a document and assigned to a participant.

List Fields by Document ID
Retrieves all fields associated with a specific document.
Create Field(s) by Document ID
Creates one or more fields on a document and assigns them to participants. Provide one item for a single field, or multiple items for a bulk request. Each field specifies:
- participantID — the participant assigned to the field.
- type — one of signature, initials, name, date, title, company, checkbox, custom.
- page — the page number (1-based indexing).
- X Position, Y Position, Width, Height — the field's position and size, each entered as a separate number in points (X/Y are measured from the left/top edge of the page). These replace the previous single boundingBox array, so each value is a typed field in the UI rather than a hand-built list.
- Optional: required (default true), and — under Advanced — format (e.g. MM/DD/YYYY for date fields) and modifiable.
Update Field by ID
Updates properties of an existing field. The field type must be provided and must match the existing field type — it is used to identify the field schema and does not change the field type.
Delete Field by ID
Permanently deletes a field from a document.

4. Participants

Participants are the people who receive the envelope — either to sign it or to be kept informed.

List Participants by Envelope ID
Retrieves all participants associated with an envelope.
Create Participant(s) by Envelope ID
Adds one or more participants to an envelope. Provide one item for a single participant, or multiple items for a bulk request. Each participant specifies:
- email — the participant's email address.
- role — signer (can have fields assigned for signing) or cc (read-only access).
- authentication (advanced, optional) — currently Access Code: a static access code the participant must provide before signing. Open this section only if the participant should authenticate before signing.
Update Participant by ID
Updates a participant's authentication settings. The participant email cannot be changed.
Delete Participant by ID
Permanently deletes a participant from an envelope.

5. Downloads

Retrieve the finished files once documents have been signed and sealed.

Download Original Envelope
Downloads the original unsigned documents from an envelope as a ZIP archive.
Download Sealed Envelope
Downloads the sealed signed documents, along with the audit trail, as a ZIP archive.
Download Sealed Document by ID
Downloads a single sealed signed document as a PDF file.
Download Audit Trail of Envelope
Downloads the full audit trail for an envelope as a PDF file.

Download actions expose picker-native File Name and File Content tokens (plus File Content Type). Drop File Content straight into the file input of a downstream step — e.g. OneDrive / SharePoint Create File — and File Name into its file-name input. No body('Action_Name') expression or manually-typed filename is required; the connector wraps the downloaded ZIP or PDF into a JSON envelope so Power Automate surfaces these as ordinary dynamic-content tokens.

Typical Signing Workflow

A complete signing flow chains the actions above in order. A common Power Automate flow looks like this:

Create Envelope — set the name, notification subject/body, and signing mode (parallel or sequential). Save the returned Envelope ID.
Create Document by Envelope ID — upload one or more files to the envelope (using the Envelope ID from step 1). Save each returned Document ID.
(Optional) Reorder Documents by Envelope ID — set the document order.
Create Participant(s) by Envelope ID — add the signers and CC recipients, with their access-code authentication. Save each returned Participant ID.
Create Field(s) by Document ID — place signature/date/etc. fields on each document and assign them to participants (using the Document ID from step 2 and the Participant ID from step 3).
Send Envelope for Signing — dispatch the envelope. All documents must be in the uploaded status first.
(While pending) Send Reminders for Envelope to nudge participants, or Cancel Envelope by ID to stop the request.
(When complete) Download Sealed Envelope / Download Sealed Document by ID / Download Audit Trail of Envelope to retrieve the finished files.

Tip: The Envelope ID, Document ID, and Participant ID returned by the create actions flow naturally into the later actions via Power Automate's dynamic-content picker — pick the ID token from the upstream action rather than typing it.

Errors & Throttling

The Nitro Sign API may return the following errors:

400 — Bad request
401 — Unauthorized
404 — Not found
409 — Conflict (e.g. acting on an envelope in a state that does not allow the operation)
413 — Content too large
415 — Unsupported media type
422 — Unprocessable entity
500 — Internal server error

Throttling

API calls per connection: 100 per 60 seconds.

Platform Limits

File Size

Maximum: 25 MB per request
Applies to both single‑file and multi‑file operations.

Page Count

Maximum: 250 pages per individual document
Total combined pages across multiple documents may exceed 250.

Retention Time

Input and output files are deleted ~15 minutes after operation completion.

Notes

Envelope, document, field, and participant management actions return JSON.
Download actions return the file (ZIP or PDF) wrapped in a JSON envelope exposing File Name, File Content Type, and File Content as picker-native tokens, so results can be chained into a downstream file action without expressions.
Signing mode (parallel vs sequential) is set when the envelope is created and can be changed with Update Envelope before the envelope is sent.
Participant authentication currently supports Access Code only.

Creating a connection

The connector supports the following authentication types:


Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
Nitro Client ID	securestring	Your Nitro application Client ID	True
Nitro Client Secret	securestring	Your Nitro application Client Secret	True
Nitro Region	string	Select the Nitro API region for your account.	True

Actions

Cancel Envelope by ID	Cancels the signing request for a Nitro Sign envelope. Only envelopes that have been sent for signing can be cancelled.
Create Document by Envelope ID	Uploads a document to an existing Nitro Sign envelope. The document can later be used in the signing workflow.
Create Envelope	Creates a new Nitro Sign envelope that can later be populated with documents, participants, fields, and sent for signing.
Create Field(s) by Document ID	Creates one or more fields on a document and assigns them to participants. To create a single field, provide one item in the Fields array. To create multiple fields, provide multiple items.
Create Participant(s) by Envelope ID	Adds one or more participants to a Nitro Sign envelope. To add a single participant, provide one item in the Participants array. To add multiple participants, provide multiple items.
Delete Document by ID	Permanently deletes a document from a Nitro Sign envelope.
Delete Envelope by ID	Permanently deletes a Nitro Sign envelope. This operation cannot be undone, and all associated documents, fields, and participants are also deleted.
Delete Field by ID	Permanently deletes a field from a document within a Nitro Sign envelope.
Delete Participant by ID	Permanently deletes a participant from a Nitro Sign envelope.
Download Audit Trail of Envelope	Downloads the PDF file containing the full audit trail for the selected Nitro Sign envelope.
Download Original Envelope	Downloads the original unsigned documents from a Nitro Sign envelope as a ZIP archive.
Download Sealed Document by ID	Downloads a single sealed signed document from a Nitro Sign envelope as a PDF file.
Download Sealed Envelope	Downloads the sealed signed documents from a Nitro Sign envelope, along with the audit trail, as a ZIP archive.
Get Document by ID	Retrieves details for a specific document in a Nitro Sign envelope.
Get Envelope by ID	Retrieves details for a specific Nitro Sign envelope using its unique envelope ID.
List Documents by Envelope ID	Retrieves all documents associated with a specific Nitro Sign envelope.
List Envelopes	The List Envelopes endpoint returns all envelopes associated with an application in an account.
List Fields by Document ID	Retrieves all fields associated with a specific document within a Nitro Sign envelope.
List Participants by Envelope ID	Retrieves all participants associated with a specific Nitro Sign envelope.
Reorder Documents by Envelope ID	Reorders documents associated with a specific Nitro Sign envelope based on the provided list of document IDs.
Send Envelope for Signing	Sends a Nitro Sign envelope to participants for signature collection. Before using this action, the envelope should normally have documents, participants, and signing fields added using Create Document by Envelope ID, Create Participant(s) by Envelope ID, and Create Field(s) by Document ID. All documents in the envelope must have an uploaded status before the envelope can be sent.
Send Reminders for Envelope	Triggers reminder notifications to pending participants of a specified Nitro Sign envelope. If no notification settings are provided, the default notification template configured for the envelope is used.
Update Document by ID	Updates an existing document's metadata within a Nitro Sign envelope. Currently, only the document name can be updated.
Update Envelope	Updates an existing Nitro Sign envelope. You can modify the envelope name, notification settings, signing mode, or any combination of these fields.
Update Field by ID	Updates properties of an existing field in a Nitro Sign document. The field type must be provided and must match the existing field type; it is used by the API to identify the field schema and does not change the field type.
Update Participant by ID	Updates authentication settings for a participant in a Nitro Sign envelope. The participant email cannot be updated.

Cancel Envelope by ID

Operation ID:: CancelEnvelopeByID

Cancels the signing request for a Nitro Sign envelope. Only envelopes that have been sent for signing can be cancelled.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope to cancel.

Returns

Response returned after a Nitro Sign envelope is requested or created.

Body: EnvelopeResponse

Create Document by Envelope ID

Operation ID:: CreateDocumentByEnvelopeID

Uploads a document to an existing Nitro Sign envelope. The document can later be used in the signing workflow.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope where the document will be uploaded.
Document Name	documentName	True	string	The name of the document to upload. This value will be used to build the document metadata sent to Nitro.
Content Type	contentType		string	The content type of the uploaded document. For PDF files, use application/pdf. When is omitted from the metadata, only PDF files are accepted.
Document File	payload	True	file	The document file to upload to the envelope.

Returns

Name	Path	Type	Description
Document ID	ID	uuid	A unique UUID that identifies the uploaded document.
Document Name	name	string	The name of the uploaded document.
Created At	createdAt	string	Timestamp indicating when the document was created.
Document Status	status	string	The processing status of the uploaded document.

Create Envelope

Operation ID:: CreateEnvelope

Creates a new Nitro Sign envelope that can later be populated with documents, participants, fields, and sent for signing.

Parameters

Name	Key	Required	Type	Description
Envelope Name	name	True	string	The name of the envelope. It does not have to be unique.
Signing Mode	mode	True	string	Defines the signing order. Use parallel to notify all participants at the same time, or sequential to notify participants one by one in the order they were added.
Notification Subject	subject	True	string	The subject line of the email notification sent to signing participants. Dynamic variables are supported, for example: $(sender_name_or_email) is requesting your signature.
Notification Body	body	True	string	The email body sent to signing participants. Dynamic variables are supported, for example: Hi,\nPlease sign the $(envelope_name)\nThank you,\n$(sender_name_or_email).

Returns

Response returned after a Nitro Sign envelope is requested or created.

Body: EnvelopeResponse

Create Field(s) by Document ID

Operation ID:: CreateFieldsByDocumentID

Creates one or more fields on a document and assigns them to participants. To create a single field, provide one item in the Fields array. To create multiple fields, provide multiple items.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope.
Document ID	documentID	True	uuid	A unique UUID that identifies the document where fields should be created.
Participant ID	participantID	True	uuid	The unique identifier of the participant assigned to the field.
Page	page	True	integer	The page number where the field should be placed. Pages use 1-based indexing, so the first page is 1.
Field Type	type	True	string	The type of field to create.
X Position	x	True	float	The horizontal position of the field, measured from the left edge of the page in points.
Y Position	y	True	float	The vertical position of the field, measured from the top edge of the page in points.
Width	width	True	float	The width of the field in points.
Height	height	True	float	The height of the field in points.
Required	required		boolean	Indicates whether the participant must complete this field.
Format	format		string	Optional format for field types that support formatting, for example date fields. Example: MM/DD/YYYY.
Modifiable	modifiable		boolean	Indicates whether the field value can be modified by the participant, where supported by the field type.

Returns

Response returned after creating one or more fields.

Body: FieldsResponse

Create Participant(s) by Envelope ID

Operation ID:: CreateParticipantsByEnvelopeID

Adds one or more participants to a Nitro Sign envelope. To add a single participant, provide one item in the Participants array. To add multiple participants, provide multiple items.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope where participants should be added.
Email	email	True	email	The email address of the participant.
Role	role	True	string	The participant role. A signer can have fields assigned for signing. A cc participant has read-only access.
Authentication Type	type		string	Optional. Select an authentication method for the participant. If specified, an Access Code should also be provided.
Access Code	accessCode		string	Required only when Authentication Type is specified. Leave blank if participant authentication is not required.

Returns

Response returned after creating one or more participants.

Body: ParticipantsResponse

Delete Document by ID

Operation ID:: DeleteDocumentByID

Permanently deletes a document from a Nitro Sign envelope.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope containing the document.
Document ID	documentID	True	uuid	A unique UUID that identifies the document to delete.

Delete Envelope by ID

Operation ID:: DeleteEnvelopeByID

Permanently deletes a Nitro Sign envelope. This operation cannot be undone, and all associated documents, fields, and participants are also deleted.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope to delete.

Delete Field by ID

Operation ID:: DeleteFieldByID

Permanently deletes a field from a document within a Nitro Sign envelope.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope containing the document.
Document ID	documentID	True	uuid	A unique UUID that identifies the document containing the field.
Field ID	fieldID	True	uuid	A unique UUID that identifies the field to delete.

Delete Participant by ID

Operation ID:: DeleteParticipantByID

Permanently deletes a participant from a Nitro Sign envelope.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope containing the participant.
Participant ID	participantID	True	uuid	A unique UUID that identifies the participant to delete.

Download Audit Trail of Envelope

Operation ID:: DownloadAuditTrailOfEnvelope

Downloads the PDF file containing the full audit trail for the selected Nitro Sign envelope.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope whose audit trail should be downloaded.

Returns

Downloaded file wrapped as a JSON envelope.

Body: FileDownloadResponse

Download Original Envelope

Operation ID:: DownloadOriginalEnvelope

Downloads the original unsigned documents from a Nitro Sign envelope as a ZIP archive.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope whose original documents should be downloaded.

Returns

Downloaded file wrapped as a JSON envelope.

Body: FileDownloadResponse

Download Sealed Document by ID

Operation ID:: DownloadSealedDocumentByID

Downloads a single sealed signed document from a Nitro Sign envelope as a PDF file.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope containing the sealed document.
Document ID	documentID	True	uuid	A unique UUID that identifies the sealed document to download.

Returns

Downloaded file wrapped as a JSON envelope.

Body: FileDownloadResponse

Download Sealed Envelope

Operation ID:: DownloadSealedEnvelope

Downloads the sealed signed documents from a Nitro Sign envelope, along with the audit trail, as a ZIP archive.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope whose sealed documents should be downloaded.

Returns

Downloaded file wrapped as a JSON envelope.

Body: FileDownloadResponse

Get Document by ID

Operation ID:: GetDocumentByID

Retrieves details for a specific document in a Nitro Sign envelope.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope containing the document.
Document ID	documentID	True	uuid	A unique UUID that identifies the document to retrieve.

Returns

Nitro Sign document details.

Body: DocumentResponse

Get Envelope by ID

Operation ID:: GetEnvelopeByID

Retrieves details for a specific Nitro Sign envelope using its unique envelope ID.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope to retrieve.

Returns

Response returned after a Nitro Sign envelope is requested or created.

Body: EnvelopeResponse

List Documents by Envelope ID

Operation ID:: ListDocumentsByEnvelopeID

Retrieves all documents associated with a specific Nitro Sign envelope.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope whose documents should be retrieved.

Returns

Response returned when listing documents associated with a Nitro Sign envelope.

Body: ListDocumentsByEnvelopeIDResponse

List Envelopes

Operation ID:: ListEnvelopes

The List Envelopes endpoint returns all envelopes associated with an application in an account.

Parameters

Name	Key	Required	Type	Description
Page After	pageAfter		string	Optional cursor token used to retrieve the next page of envelopes. Use the nextPage value returned by the previous response.
Page Before	pageBefore		string	Optional cursor token used to retrieve the previous page of envelopes. Do not use together with Page After.

Returns

Name	Path	Type	Description
Envelopes	items	array of EnvelopeSummaryResponse	The list of envelopes.
Next Page	nextPage	string	Cursor token that can be used as Page After to retrieve the next page of envelopes.

List Fields by Document ID

Operation ID:: ListFieldsByDocumentID

Retrieves all fields associated with a specific document within a Nitro Sign envelope.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope containing the document.
Document ID	documentID	True	uuid	A unique UUID that identifies the document whose fields should be retrieved.

Returns

Response returned after creating one or more fields.

Body: FieldsResponse

List Participants by Envelope ID

Operation ID:: ListParticipantsByEnvelopeID

Retrieves all participants associated with a specific Nitro Sign envelope.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope whose participants should be retrieved.

Returns

Response returned when listing participants associated with a Nitro Sign envelope.

Body: ParticipantsListResponse

Reorder Documents by Envelope ID

Operation ID:: ReorderDocumentsByEnvelopeID

Reorders documents associated with a specific Nitro Sign envelope based on the provided list of document IDs.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope whose documents should be reordered.
Document IDs	order	True	array of uuid	An array of document IDs representing the new order of documents within the envelope.

Returns

Response returned when listing documents associated with a Nitro Sign envelope.

Body: ListDocumentsByEnvelopeIDResponse

Send Envelope for Signing

Operation ID:: SendEnvelopeForSigning

Sends a Nitro Sign envelope to participants for signature collection. Before using this action, the envelope should normally have documents, participants, and signing fields added using Create Document by Envelope ID, Create Participant(s) by Envelope ID, and Create Field(s) by Document ID. All documents in the envelope must have an uploaded status before the envelope can be sent.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope to send for signing.

Returns

Summary information about a Nitro Sign envelope.

Body: EnvelopeSummaryResponse

Send Reminders for Envelope

Operation ID:: SendRemindersForEnvelope

Triggers reminder notifications to pending participants of a specified Nitro Sign envelope. If no notification settings are provided, the default notification template configured for the envelope is used.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope for which reminder notifications should be sent.
Notification Subject	subject		string	The subject line of the email notification sent to signing participants. Dynamic variables are supported, for example: $(sender_name_or_email) is requesting your signature.
Notification Body	body		string	The email body sent to signing participants. Dynamic variables are supported, for example: Hi,\nPlease sign the $(envelope_name)\nThank you,\n$(sender_name_or_email).

Update Document by ID

Operation ID:: UpdateDocumentByID

Updates an existing document's metadata within a Nitro Sign envelope. Currently, only the document name can be updated.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope containing the document.
Document ID	documentID	True	uuid	A unique UUID that identifies the document to update.
Document Name	name	True	string	The new name for the document.

Returns

Nitro Sign document details.

Body: DocumentResponse

Update Envelope

Operation ID:: UpdateEnvelope

Updates an existing Nitro Sign envelope. You can modify the envelope name, notification settings, signing mode, or any combination of these fields.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope to update.
Envelope Name	name		string	The updated envelope name. It does not have to be unique.
Notification Subject	subject		string	The subject line of the email notification sent to signing participants. Dynamic variables are supported, for example: $(sender_name_or_email) is requesting your signature.
Notification Body	body		string	The email body sent to signing participants. Dynamic variables are supported, for example: Hi,\nPlease sign the $(envelope_name)\nThank you,\n$(sender_name_or_email).
Signing Mode	mode		string	Defines the signing order. Use parallel to notify all participants at the same time, or sequential to notify participants one by one in the order they were added.

Returns

Response returned after a Nitro Sign envelope is requested or created.

Body: EnvelopeResponse

Update Field by ID

Operation ID:: UpdateFieldByID

Updates properties of an existing field in a Nitro Sign document. The field type must be provided and must match the existing field type; it is used by the API to identify the field schema and does not change the field type.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope containing the document.
Document ID	documentID	True	uuid	A unique UUID that identifies the document containing the field.
Field ID	fieldID	True	uuid	A unique UUID that identifies the field to update.
Field Type	type	True	string	The current type of the field being updated. This value is required by the API and must match the existing field type; it does not change the field type.
Participant ID	participantID		uuid	The unique identifier of the participant assigned to the field.
Page	page		integer	The page number where the field appears. Pages use 1-based indexing.
X Position	x		float	Optional. The horizontal position of the field, measured from the left edge of the page in points.
Y Position	y		float	Optional. The vertical position of the field, measured from the top edge of the page in points.
Width	width		float	Optional. The width of the field in points.
Height	height		float	Optional. The height of the field in points.
Required	required		boolean	Indicates whether the participant must complete this field.
Format	format		string	The field format, where applicable. For example, date fields can use a format such as MM/DD/YYYY.
Modifiable	modifiable		boolean	Indicates whether the field value is modifiable, where applicable.

Returns

Nitro Sign field details.

Body: FieldResponse

Update Participant by ID

Operation ID:: UpdateParticipantByID

Updates authentication settings for a participant in a Nitro Sign envelope. The participant email cannot be updated.

Parameters

Name	Key	Required	Type	Description
Envelope ID	envelopeID	True	uuid	A unique UUID that identifies the envelope containing the participant.
Participant ID	participantID	True	uuid	A unique UUID that identifies the participant to update.
Authentication Type	type		string	Optional. Select an authentication method for the participant. If specified, an Access Code should also be provided.
Access Code	accessCode		string	Required only when Authentication Type is specified. Leave blank if participant authentication is not required.

Returns

Nitro Sign participant details.

Body: ParticipantResponse

Definitions

EnvelopeNotification

Notification email settings for a Nitro Sign envelope.

Name	Path	Type	Description
Notification Subject	subject	string	The subject line of the email notification sent to signing participants. Dynamic variables are supported, for example: $(sender_name_or_email) is requesting your signature.
Notification Body	body	string	The email body sent to signing participants. Dynamic variables are supported, for example: Hi,\nPlease sign the $(envelope_name)\nThank you,\n$(sender_name_or_email).

EnvelopeSummaryResponse

Summary information about a Nitro Sign envelope.

Name	Path	Type	Description
Envelope ID	ID	uuid	A unique UUID that identifies the envelope.
Created At	createdAt	date-time	UTC timestamp indicating when the envelope was created.
Last Modified At	lastModifiedAt	date-time	UTC timestamp indicating when the envelope was last modified.
Envelope Name	name	string	The name of the envelope.
Envelope Status	status	string	The internal status of the envelope.

EnvelopeResponse

Response returned after a Nitro Sign envelope is requested or created.

Name	Path	Type	Description
Envelope ID	ID	uuid	A unique UUID that identifies the envelope.
Created At	createdAt	date-time	UTC timestamp indicating when the envelope was created.
Last Modified At	lastModifiedAt	date-time	UTC timestamp indicating when the envelope was last modified.
Envelope Name	name	string	The name of the envelope.
Envelope Status	status	string	The internal status of the envelope.
Signing Mode	mode	string	The signing mode configured for the envelope.
notification	notification	EnvelopeNotification	Notification email settings for a Nitro Sign envelope.

ListDocumentsByEnvelopeIDResponse

Response returned when listing documents associated with a Nitro Sign envelope.

Name	Path	Type	Description
Documents	items	array of DocumentResponse	The list of documents associated with the envelope.

DocumentResponse

Nitro Sign document details.

Name	Path	Type	Description
Document ID	ID	uuid	A unique UUID that identifies the document.
Document Name	name	string	The name of the document.
Created At	createdAt	date-time	UTC timestamp indicating when the document was created.
Size in Bytes	sizeBytes	integer	The document size in bytes.
Number of Pages	numPages	integer	The number of pages in the document.
Document Status	status	string	The current status of the document.

FieldsResponse

Response returned after creating one or more fields.

Name	Path	Type	Description
Fields	items	array of FieldResponse	The fields created in this request.

FieldResponse

Nitro Sign field details.

Name	Path	Type	Description
Field ID	ID	uuid	A unique UUID that identifies the field.
Participant ID	participantID	uuid	The unique identifier of the participant assigned to the field.
Document ID	documentID	uuid	The unique identifier of the document to which the field belongs.
Page	page	integer	The page number where the field appears.
Bounding Box	boundingBox	array of float	An array of four numbers in the format [x, y, width, height], measured in points.
Required	required	boolean	Indicates whether the participant must complete this field.
Field Type	type	string	The type of field.
Format	format	string	The field format, where applicable.
Modifiable	modifiable	boolean	Indicates whether the field value is modifiable, where applicable.

ParticipantsResponse

Response returned after creating one or more participants.

Name	Path	Type	Description
Participants	items	array of ParticipantResponse	The participants created in this request.

ParticipantsListResponse

Response returned when listing participants associated with a Nitro Sign envelope.

Name	Path	Type	Description
Participants	items	array of ParticipantResponse	The participants associated with the envelope.
Total Participants	total	integer	The total number of participants available in the collection.

ParticipantResponse

Nitro Sign participant details.

Name	Path	Type	Description
Participant ID	ID	uuid	A unique UUID that identifies the participant.
Email	email	email	The email address of the participant.
Role	role	string	The role of the participant.
authentication	authentication	ParticipantAuthenticationResponse	Authentication settings returned for a participant.

ParticipantAuthenticationResponse

Authentication settings returned for a participant.

Name	Path	Type	Description
Authentication Type	type	string	The participant authentication type.
Access Code	accessCode	string	The access code configured for the participant.

FileDownloadResponse

Downloaded file wrapped as a JSON envelope.

Name	Path	Type	Description
File Name	fileName	string	The name of the downloaded file, derived from the response Content-Disposition header (for example result.zip or result.pdf). Drop this token directly into the File Name input of a downstream action such as OneDrive or SharePoint Create File.
File Content Type	fileContentType	string	The MIME type of the downloaded file, for example application/zip or application/pdf.
File Content	fileContent	byte	The base64-encoded file content. Drop this token directly into the File Content input of a downstream action (for example OneDrive or SharePoint Create File, or another Nitro action) - no expression required.