DocuSign: Updates a signing group
DocuSign esignature.esignatureSigningGroupsPutSigningGroup: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_signinggroups_putsigninggroup
Provider route: PUT /restapi/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}. 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"]["esignatureSigningGroupsPutSigningGroup"]>[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.esignatureSigningGroupsPutSigningGroup(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_signing_groups_put_signing_group(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.signingGroupId | string | Required within parent | |
body | Model | Optional | Expand Updates a signing group — response body |
Referenced models: Updates a signing group — response 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 Updates a signing group — response body |
Referenced models: Updates a signing group — response body
Schemas
Section titled “Schemas”Updates a signing group — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains details about a signing group. Signing groups enable you to send an envelope to a predefined group of recipients and have any one member of the group sign your documents. When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. |
created | string | Optional | The UTC DateTime when the signing group was created. This property is read-only. |
createdBy | string | Optional | The name of the user who created the signing group. This property is read-only. |
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. |
groupEmail | string | Optional | The email address for the signing group. You can use a group email address to email all of the group members at the same time. |
groupName | string | Optional | The name of the group. |
groupType | string | Optional | The type of the group. The only valid value for this request is `sharedSigningGroup`. |
modified | string | Optional | The UTC DateTime when the signing group was last modified. This property is read-only. |
modifiedBy | string | Optional | The user ID (GUID) of the user who last modified this user record. This property is read-only. |
signingGroupId | string | Optional | The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). |
users | array | Optional | User management information. |
users[] | Model | Each item | Expand Updates a signing group — response body — users item |
Referenced models: Locks a template — response body — error Details, Updates a signing group — response body — users item
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. |
Updates a signing group — response body — users item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Optional | |
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. |
userName | string | Optional | The name of the group member. Maximum Length: 100 characters. |
Referenced models: Locks a template — response body — error Details
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_signinggroups_putsigninggroup. Catalog operation: esignature:SigningGroups_PutSigningGroup. 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.