docusign.signing-groups.put-signing-group

Updates signing group name and member information. You can also add new members to the signing group. A signing group can have a maximum of 50 members.

Updates a signing group.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
signinggroupid	string	Yes	—	The ID of the signing group.
created	string	No	—	The UTC DateTime when the signing group was created. This property is read-only.
createdby	string	No	—	The name of the user who created the signing group. This property is read-only.
errordetails	json	No	—	This object describes errors that occur. It is only valid for responses and ignored in requests.
groupemail	string	No	—	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	No	—	The name of the group.
grouptype	string	No	—	The type of the group. The only valid value for this request is sharedSigningGroup.
modified	string	No	—	The UTC DateTime when the signing group was last modified. This property is read-only.
modifiedby	string	No	—	The user ID (GUID) of the user who last modified this user record. This property is read-only.
signinggroupid_2	string	No	—	The ID of the signing group.
users	list	No	—	User management information.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
signinggroupid	string	Yes	—	The ID of the signing group.
created	string	No	—	The UTC DateTime when the signing group was created. This property is read-only.
createdby	string	No	—	The name of the user who created the signing group. This property is read-only.
errordetails	json	No	—	This object describes errors that occur. It is only valid for responses and ignored in requests.
groupemail	string	No	—	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	No	—	The name of the group.
grouptype	string	No	—	The type of the group. The only valid value for this request is sharedSigningGroup.
modified	string	No	—	The UTC DateTime when the signing group was last modified. This property is read-only.
modifiedby	string	No	—	The user ID (GUID) of the user who last modified this user record. This property is read-only.
signinggroupid_2	string	No	—	The ID of the signing group.
users	list	No	—	User management information.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call PUT /v2.1/accounts/{accountId}/signing_groups/
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform PUT /v2.1/accounts/{accountId}/signing_groups/
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.signing-groups.put-signing-group",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "signinggroupid": "value"
  }
}