SigningGroupsApi
All URIs are relative to https://api.esignlaunchpad.com
| Method | HTTP request | Description |
|---|---|---|
| addSigningGroupMember | POST /api/v1/signing-groups//members | Add a member to a signing group |
| bulkDeleteSigningGroups | POST /api/v1/signing-groups/bulk-delete | Bulk delete signing groups |
| createSigningGroup | POST /api/v1/signing-groups | Create a signing group |
| deleteSigningGroup | DELETE /api/v1/signing-groups/ | Delete a signing group |
| getSigningGroup | GET /api/v1/signing-groups/ | Get a signing group |
| listSigningGroupMembers | GET /api/v1/signing-groups//members | List signing group members |
| listSigningGroups | GET /api/v1/signing-groups | List signing groups |
| removeSigningGroupMember | DELETE /api/v1/signing-groups//members/ | Remove a signing group member |
| updateSigningGroup | PUT /api/v1/signing-groups/ | Update a signing group |
addSigningGroupMember
SigningGroupMemberApiResponse addSigningGroupMember(id, AddSigningGroupMemberApiRequest)
Add a member to a signing group
Adds a new person (identified by email address) to the signing group. If a member with the same email already exists in the group, a `400 Bad Request` is returned. Members added after a package has been sent will not receive invitations for that package; they will only be included in future sends.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | The unique identifier (GUID) of the signing group. | [default to null] |
| AddSigningGroupMemberApiRequest | AddSigningGroupMemberApiRequest | Cancellation token. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
bulkDeleteSigningGroups
BulkDeleteApiResponse bulkDeleteSigningGroups(BulkDeleteApiRequest)
Bulk delete signing groups
Accepts a list of signing group GUIDs and attempts to delete each one. The response contains per-item results so callers can identify which deletions succeeded and which failed (e.g., because the group was not found). Validation rules: at least 1 and at most 50 GUIDs per request.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| BulkDeleteApiRequest | BulkDeleteApiRequest | Cancellation token. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
createSigningGroup
SigningGroupApiResponse createSigningGroup(CreateSigningGroupApiRequest)
Create a signing group
Creates a signing group that can later be assigned to a signer slot on a package. You may include up to 100 members in the initial request, or add them later via the `POST /api/v1/signing-groups/{id}/members` endpoint. Duplicate email addresses within the members list are rejected.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| CreateSigningGroupApiRequest | CreateSigningGroupApiRequest | Cancellation token. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
deleteSigningGroup
deleteSigningGroup(id)
Delete a signing group
Deletes the group and all of its member associations. Packages that were previously sent using this group are not affected -- their signer assignments are already resolved at send time.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | The unique identifier (GUID) of the signing group to delete. | [default to null] |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
getSigningGroup
SigningGroupApiResponse getSigningGroup(id)
Get a signing group
Returns the signing group metadata including member count. To retrieve the full member list, use `GET /api/v1/signing-groups/{id}/members`.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | The unique identifier (GUID) of the signing group. | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
listSigningGroupMembers
List listSigningGroupMembers(id)
List signing group members
Returns every member currently in the group. The group itself must exist; a `404 Not Found` is returned if the group GUID is invalid.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | The unique identifier (GUID) of the signing group. | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
listSigningGroups
SigningGroupListApiResponse listSigningGroups(page, pageSize, search, sortBy, descending, updatedSince)
List signing groups
Returns every signing group owned by the tenant. Each group includes its member count but not the full member list; use `GET /api/v1/signing-groups/{id}/members` to retrieve individual members.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | [optional] [default to null] | |
| pageSize | Integer | [optional] [default to null] | |
| search | String | [optional] [default to null] | |
| sortBy | String | [optional] [default to null] | |
| descending | Boolean | [optional] [default to null] | |
| updatedSince | Date | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
removeSigningGroupMember
removeSigningGroupMember(id, email)
Remove a signing group member
Removes the member whose email matches the route parameter. The email is matched case-insensitively. Removing a member does not affect packages that have already been sent -- their signer assignments are resolved at send time.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | The unique identifier (GUID) of the signing group. | [default to null] |
| String | The email address of the member to remove (URL-encoded if it contains special characters). | [default to null] |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
updateSigningGroup
SigningGroupApiResponse updateSigningGroup(id, UpdateSigningGroupApiRequest)
Update a signing group
Only the fields provided in the request body are updated; omitted or null fields are left unchanged. To manage the member list, use the dedicated member endpoints (`POST .../members` and `DELETE .../members/{email}`).
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | The unique identifier (GUID) of the signing group to update. | [default to null] |
| UpdateSigningGroupApiRequest | UpdateSigningGroupApiRequest | Cancellation token. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json