DocuSign: esignature:Envelopes Shares Post Envelopes Shares
DocuSign esignature.esignatureEnvelopesSharesPostEnvelopesShares: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_envelopesshares_postenvelopesshares
Provider route: POST /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares. 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"]["esignatureEnvelopesSharesPostEnvelopesShares"]>[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.esignatureEnvelopesSharesPostEnvelopesShares(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_shares_post_envelopes_shares(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 | |
path.envelopeId | string | Required within parent | |
body | Model | Optional | Expand esignature:Envelopes Shares Put Envelopes Shares — request body — body |
Referenced models: esignature:Envelopes Shares Put Envelopes Shares — 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 esignature:Envelopes Shares Get Envelopes Shares — response body |
Referenced models: esignature:Envelopes Shares Get Envelopes Shares — response body
Schemas
Section titled “Schemas”esignature:Envelopes Shares Get Envelopes Shares — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
shares | array | Optional | |
shares[] | Model | Each item | Expand esignature:Envelopes Shares Get Envelopes Share — response body |
Referenced models: esignature:Envelopes Shares Get Envelopes Share — response body
esignature:Envelopes Shares Put Envelopes Shares — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
shares | array | Optional | |
shares[] | Model | Each item | Expand esignature:Envelopes Shares Put Envelopes Shares — request body — body shares item |
Referenced models: esignature:Envelopes Shares Put Envelopes Shares — request body — body shares item
esignature:Envelopes Shares Get Envelopes Share — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
agentUser | Model | Optional | Expand esignature:Envelopes Shares Get Envelopes Share — response body — agent User |
createdTimestamp | string | Optional | |
envelopeId | string | Optional | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
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. |
modifiedTimestamp | string | Optional | |
permission | string | Optional | |
senderInfo | Model | Optional | Expand esignature:Envelopes Shares Get Envelopes Share — response body — agent User |
shareId | string | Optional | |
subject | string | Optional |
Referenced models: esignature:Envelopes Shares Get Envelopes Share — response body — agent User, Locks a template — response body — error Details
esignature:Envelopes Shares Put Envelopes Shares — request body — body shares item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
agentUser | Model | Optional | Expand esignature:Envelopes Shares Get Envelopes Share — response body — agent User |
customMessage | string | Optional | |
permission | string | Optional |
Referenced models: esignature:Envelopes Shares Get Envelopes Share — response body — agent User
esignature:Envelopes Shares Get Envelopes Share — response body — agent User
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountId | string | Optional | The account ID. |
email | string | Optional | The email address of the authorization user. |
name | string | Optional | The name of the authorization user. |
userId | string | Optional | The ID of the authorization user. |
Locks a template — response body — error Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes errors that occur. It is only valid for responses and ignored in requests. |
errorCode | string | Optional | The code associated with the error condition. |
message | string | Optional | A brief message describing the error condition. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_envelopesshares_postenvelopesshares. Catalog operation: esignature:EnvelopesShares_PostEnvelopesShares. 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.