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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.ac_status | string | Optional | |
query.block | string | Optional | |
query.count | string | Optional | |
query.email | string | Optional | |
query.envelope_ids | string | Optional | |
query.from_date | string | Optional | |
query.from_to_status | string | Optional | |
query.start_position | string | Optional | |
query.status | string | Optional | |
query.to_date | string | Optional | |
query.transaction_ids | string | Optional | |
query.user_name | string | Optional | |
body | Model | Optional | Expand 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
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Gets envelope statuses for a set of envelopes — response body |
Referenced models: Gets envelope statuses for a set of envelopes — response body
Schemas
Section titled “Schemas”145 more schemas are linked from the tables above, on the schema pages.
Gets envelope statuses for a set of envelopes — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Result set for the Envelopes: listStatusChanges method |
continuationToken | string | Optional | Reserved for Docusign. |
endPosition | string | Optional | The last index position in the result set. |
envelopeSearchSource | string | Optional | |
envelopeTransactionStatuses | array | Optional | Array of envelope statuses and transaction IDs in the result set. |
envelopeTransactionStatuses[] | Model | Each item | Expand Gets envelope statuses for a set of envelopes — response body — envelope Transaction Statuses item |
envelopes | array | Optional | Array of envelope information. |
envelopes[] | Model | Each item | Expand Gets the status of a single envelope — response body |
folders | array | Optional | A list of folder objects. |
folders[] | Model | Each item | Expand Gets the list of templates — response body — folders item |
lastQueriedDateTime | string | Optional | The last time that a query was performed. |
nextUri | string | Optional | The 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. |
previousUri | string | Optional | The 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. |
resultSetSize | string | Optional | The 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`. |
startPosition | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Lists 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` |
envelopeIds | array | Optional | A comma-separated list of envelope IDs to include in the results. |
envelopeIds[] | string | Each item | |
transactionIds | array | Optional | A comma-separated list of transaction IDs to include in the results. Note that transaction IDs are valid for seven days. |
transactionIds[] | string | Each item |
Gets envelope statuses for a set of envelopes — response body — envelope Transaction Statuses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
envelopeId | string | Optional | The envelope ID of the envelope status that failed to post. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
status | string | Optional | Indicates 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. |
transactionId | string | Optional | Used 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains details about a folder. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
filter | Model | Optional | Expand Gets the list of templates — response body — folders item filter An object used to present a filtered view of the items in a folder. |
folderId | string | Optional | The ID of the folder. |
folderItems | array | Optional | A list of envelopes and templates that the folder contains. |
folderItems[] | Model | Each item | Expand Deprecated. Use Envelopes: list Status Changes — response body — folder Items item |
folders | array | Optional | A collection of folder objects returned in a response. |
folders[] | Model | Each item | Expand Gets the list of templates — response body — folders item |
hasAccess | string | Optional | When **true,** the current user has access to the folder. |
hasSubFolders | string | Optional | When **true,** the folder has subfolders. |
itemCount | string | Optional | The number of items in the folder. |
name | string | Optional | The name of the folder. |
owner | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Information about the user who owns the folder. |
parentFolderId | string | Optional | The ID of the parent folder, or the special value `root` for the root folder. |
parentFolderUri | string | Optional | The URI of the parent folder. |
subFolderCount | string | Optional | The number of subfolders. |
type | string | Optional | The type of folder. Possible values include: - `draft` - `inbox` - `normal` (a system-generated folder) - `recyclebin` - `sentitems` - `custom` (a custom folder created by a user) |
uri | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An `accountCustomField` is an envelope custom field that you set at the account level. Applying custom fields enables account administrators to group and manage envelopes. |
listCustomFields | array | Optional | An array of list custom fields. |
listCustomFields[] | Model | Each item | Expand Gets a list of custom fields — response body — list Custom Fields item |
textCustomFields | array | Optional | An array of text custom fields. |
textCustomFields[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about an attachment. |
accessControl | string | Optional | Valid values are `sender` and `senderAndAllRecipients`. |
attachmentId | string | Optional | The unique identifier for the attachment. |
attachmentType | string | Optional | Specifies the type of the attachment for the recipient. |
data | string | Optional | A 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. |
label | string | Optional | A 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. |
name | string | Optional | The name of the attachment. |
remoteUrl | string | Optional | The 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. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.