Signing Groups

Updates a signing group

PUT
/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}

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.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

The external account number (int) or account ID GUID.

signingGroupId*string

The ID of the signing group.

Request Body

application/json

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

The UTC DateTime when the signing group was created. This property is read-only.

createdBy?string

The name of the user who created the signing group. This property is read-only.

errorDetails?

This object describes errors that occur. It is only valid for responses and ignored in requests.

groupEmail?string

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

The name of the group.

groupType?string

The type of the group. The only valid value for this request is sharedSigningGroup.

modified?string

The UTC DateTime when the signing group was last modified. This property is read-only.

modifiedBy?string

The user ID (GUID) of the user who last modified this user record. This property is read-only.

signingGroupId?string

The ID of the signing group.

users?array<>

User management information.

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/signing_groups/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "created": "string",  "createdBy": "string",  "errorDetails": {    "errorCode": "string",    "message": "string"  },  "groupEmail": "string",  "groupName": "string",  "groupType": "string",  "modified": "string",  "modifiedBy": "string",  "signingGroupId": "string",  "users": [    {      "email": "string",      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "userName": "string"    }  ]}