Skip to content

DocuSign: Gets envelope statuses for a set of envelopes

DocuSign esignature.esignatureEnvelopesPutStatus: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_envelopes_putstatus

Provider route: PUT /restapi/v2.1/accounts/{accountId}/envelopes/status. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureEnvelopesPutStatus"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignatureEnvelopesPutStatus(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_envelopes_put_status(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.ac_statusstringOptional
query.blockstringOptional
query.countstringOptional
query.emailstringOptional
query.envelope_idsstringOptional
query.from_datestringOptional
query.from_to_statusstringOptional
query.start_positionstringOptional
query.statusstringOptional
query.to_datestringOptional
query.transaction_idsstringOptional
query.user_namestringOptional
bodyModelOptionalExpand Gets envelope statuses for a set of envelopes — request body — body

Referenced models: Gets envelope statuses for a set of envelopes — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets envelope statuses for a set of envelopes — response body

Referenced models: Gets envelope statuses for a set of envelopes — response body

145 more schemas are linked from the tables above, on the schema pages.

Gets envelope statuses for a set of envelopes — response body
FieldTypePresenceDescription and constraints
$objectRootResult set for the Envelopes: listStatusChanges method
continuationTokenstringOptionalReserved for Docusign.
endPositionstringOptionalThe last index position in the result set.
envelopeSearchSourcestringOptional
envelopeTransactionStatusesarrayOptionalArray of envelope statuses and transaction IDs in the result set.
envelopeTransactionStatuses[]ModelEach itemExpand Gets envelope statuses for a set of envelopes — response body — envelope Transaction Statuses item
envelopesarrayOptionalArray of envelope information.
envelopes[]ModelEach itemExpand Gets the status of a single envelope — response body
foldersarrayOptionalA list of folder objects.
folders[]ModelEach itemExpand Gets the list of templates — response body — folders item
lastQueriedDateTimestringOptionalThe last time that a query was performed.
nextUristringOptionalThe URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search.
previousUristringOptionalThe URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search.
resultSetSizestringOptionalThe number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.

Referenced models: Gets the status of a single envelope — response body, Gets envelope statuses for a set of envelopes — response body — envelope Transaction Statuses item, Gets the list of templates — response body — folders item

Gets envelope statuses for a set of envelopes — request body — body
FieldTypePresenceDescription and constraints
$objectRootLists of envelope and transaction IDs to use in the results.

If you use this request body with Envelopes: listStatus,
you must set one or both of the following query parameters
to the special value `request_body`:

- `envelope_ids=request_body`
- `transaction_ids=request_body`
envelopeIdsarrayOptionalA comma-separated list of envelope IDs to include in the results.
envelopeIds[]stringEach item
transactionIdsarrayOptionalA comma-separated list of transaction IDs to include in the results. Note that transaction IDs are valid for seven days.
transactionIds[]stringEach item
Gets envelope statuses for a set of envelopes — response body — envelope Transaction Statuses item
FieldTypePresenceDescription and constraints
$objectRoot
envelopeIdstringOptionalThe envelope ID of the envelope status that failed to post.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
statusstringOptionalIndicates the envelope status. Valid values are:

* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.
* `created`: The envelope is created as a draft. It can be modified and sent later.
* `declined`: The envelope has been declined by the recipients.
* `delivered`: The envelope has been delivered to the recipients.
* `sent`: The envelope will be sent to the recipients after the envelope is created.
* `signed`: The envelope has been signed by the recipients.
* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.
transactionIdstringOptionalUsed to identify an envelope. The ID is a sender-generated value and is valid in the Docusign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.

Referenced models: Locks a template — response body — error Details

Gets the list of templates — response body — folders item
FieldTypePresenceDescription and constraints
$objectRootThis object contains details about a folder.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
filterModelOptionalExpand Gets the list of templates — response body — folders item filter
An object used to present a filtered view of the items in a folder.
folderIdstringOptionalThe ID of the folder.
folderItemsarrayOptionalA list of envelopes and templates that the folder contains.
folderItems[]ModelEach itemExpand Deprecated. Use Envelopes: list Status Changes — response body — folder Items item
foldersarrayOptionalA collection of folder objects returned in a response.
folders[]ModelEach itemExpand Gets the list of templates — response body — folders item
hasAccessstringOptionalWhen **true,** the current user has access to the folder.
hasSubFoldersstringOptionalWhen **true,** the folder has subfolders.
itemCountstringOptionalThe number of items in the folder.
namestringOptionalThe name of the folder.
ownerModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Information about the user who owns the folder.
parentFolderIdstringOptionalThe ID of the parent folder, or the special value `root` for the root folder.
parentFolderUristringOptionalThe URI of the parent folder.
subFolderCountstringOptionalThe number of subfolders.
typestringOptionalThe type of folder. Possible values include:

- `draft`
- `inbox`
- `normal` (a system-generated folder)
- `recyclebin`
- `sentitems`
- `custom` (a custom folder created by a user)
uristringOptionalThe URI for the folder.

Referenced models: Locks a template — response body — error Details, Gets the list of templates — response body — folders item filter, Gets the list of templates — response body — folders item, Deprecated. Use Envelopes: list Status Changes — response body — folder Items item, Gets a specific template associated with a specified account — response body — owner

Gets a list of custom fields — response body
FieldTypePresenceDescription and constraints
$objectRootAn `accountCustomField` is an envelope custom field that you set at the account level.
Applying custom fields enables account administrators to group and manage envelopes.
listCustomFieldsarrayOptionalAn array of list custom fields.
listCustomFields[]ModelEach itemExpand Gets a list of custom fields — response body — list Custom Fields item
textCustomFieldsarrayOptionalAn array of text custom fields.
textCustomFields[]ModelEach itemExpand Gets a list of custom fields — response body — text Custom Fields item

Referenced models: Gets a list of custom fields — response body — list Custom Fields item, Gets a list of custom fields — response body — text Custom Fields item

Updates an envelope attachment in a draft or in-process envelope — request body — body
FieldTypePresenceDescription and constraints
$objectRootContains information about an attachment.
accessControlstringOptionalValid values are `sender` and `senderAndAllRecipients`.
attachmentIdstringOptionalThe unique identifier for the attachment.
attachmentTypestringOptionalSpecifies the type of the attachment for the recipient.
datastringOptionalA Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.
labelstringOptionalA label for the attachment. Potential values include:

- `guidedForm`: [Guided forms](https://www.docusign.com/products/guided-forms) provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms.
- `eventNotifications`: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the `url` property.
namestringOptionalThe name of the attachment.
remoteUrlstringOptionalThe URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads.

SDK function policy ID: docusign.esignature_envelopes_putstatus. Catalog operation: esignature:Envelopes_PutStatus. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.