Skip to content

DocuSign: Creates a signing group

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

← Esignature operations · Get started

Operation docusign.esignature_signinggroups_postsigninggroups

Provider route: POST /restapi/v2.1/accounts/{accountId}/signing_groups. 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"]["esignatureSigningGroupsPostSigningGroups"]>[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.esignatureSigningGroupsPostSigningGroups(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_signing_groups_post_signing_groups(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
bodyModelOptionalExpand Creates a signing group — response body

Referenced models: Creates a signing group — response body

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Creates a signing group — response body

Referenced models: Creates a signing group — response body

Creates a signing group — response body
FieldTypePresenceDescription and constraints
$objectRoot
groupsarrayOptionalA collection group objects containing information about the groups.
groups[]ModelEach itemExpand Updates a signing group — response body

Referenced models: Updates a signing group — response body

Updates a signing group — response body
FieldTypePresenceDescription and constraints
$objectRootContains 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.
createdstringOptionalThe UTC DateTime when the signing group was created. This property is read-only.
createdBystringOptionalThe name of the user who created the signing group. This property is read-only.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
groupEmailstringOptionalThe email address for the signing group. You can use a group email address to email all of the group members at the same time.
groupNamestringOptionalThe name of the group.
groupTypestringOptionalThe type of the group. The only valid value for this request is `sharedSigningGroup`.
modifiedstringOptionalThe UTC DateTime when the signing group was last modified. This property is read-only.
modifiedBystringOptionalThe user ID (GUID) of the user who last modified this user record. This property is read-only.
signingGroupIdstringOptionalThe ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).
usersarrayOptionalUser management information.
users[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.
Updates a signing group — response body — users item
FieldTypePresenceDescription and constraints
$objectRoot
emailstringOptional
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
userNamestringOptionalThe name of the group member.

Maximum Length: 100 characters.

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

SDK function policy ID: docusign.esignature_signinggroups_postsigninggroups. Catalog operation: esignature:SigningGroups_PostSigningGroups. 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.