Create a signing group

POST 
/agreements/:agreement_id/signing_groups

Signing groups are used to group participants when signing order is enabled. Signing order will be enabled automatically when you create your first signing group. All existing participants will be placed in the first group when the first signing group is created.

Request

Path Parameters

agreement_id cuidrequired

POST /agreements/:agreement_id/signing_groups parameter

application/json

Body

POST /agreements/:agreement_id/signing_groups request body

name string

The name of the signing group

order int64

Possible values: <= 9007199254740991

The order of the signing group. If omitted, the signing group will be added last in the signing order

participants cuid[]

Possible values: non-empty

List of IDs for the participants you wish add to the signing group. Be aware, if signing groups are used then all participants must belong to a group. Any participant not assigned to a group will be added to the last one in order. Empty groups are deleted when the agreement is finalized for signing.

Responses

200

POST /agreements/:agreement_id/signing_groups Successful response

application/json

Schema

Schema

version stringrequired

Possible values: [1.0]

The version of the response schema

result_type stringrequired

Possible values: [single]

A single object of the signing_group resource.

resource_type stringrequired

Possible values: [signing_group]

Data contains the signing_group resource.

data objectrequired

The resource data.

id cuidrequired

The unique identifier of the signing group

resource_type stringrequired

Possible values: [signing_group]

name stringrequired

The name of the signing group

status stringrequired

Possible values: [draft, pending, fulfilled]

The status of the signing group

order doublerequired

Possible values: >= 5e-324 and <= 1.7976931348623157e+308

The queue number of the signing group

participants object required

oneOf

MOD1

Array [

string

]

118cb3b11b8a1f3b6b1e60a89f96a8be9da32a0f

version stringrequired

Possible values: [1.0]

The version of the response schema

result_type stringrequired

Possible values: [single]

A single object of the signing_group resource.

resource_type stringrequired

Possible values: [signing_group]

Data contains the signing_group resource.

data objectrequired

The resource data.

id cuidrequired

The unique identifier of the signing group

resource_type stringrequired

Possible values: [signing_group]

name stringrequired

The name of the signing group

status stringrequired

Possible values: [draft, pending, fulfilled]

The status of the signing group

order doublerequired

Possible values: >= 5e-324 and <= 1.7976931348623157e+308

The queue number of the signing group

participants object required

oneOf

MOD1

Array [

string

]

MOD3

string

agreement cuidrequired

The unique identifier of the agreement this signing group belongs to

created_at stringrequired

UTC datetime ISO string

updated_at stringrequired

UTC datetime ISO string

MOD3

string

agreement cuidrequired

The unique identifier of the agreement this signing group belongs to

created_at stringrequired

UTC datetime ISO string

updated_at stringrequired

UTC datetime ISO string

Example (from schema)

{
  "version": "1.0",
  "result_type": "single",
  "resource_type": "signing_group",
  "data": {
    "id": "ch5iardyudutut6twyfexample",
    "resource_type": "signing_group",
    "name": "Board Members",
    "status": "draft",
    "order": 1,
    "participants": [
      "chdh16ordhlddmtwtueexample",
      "cjyyl51sftj7akqxa4mexample",
      "czhop8zablguspuaupjexample"
    ],
    "agreement": "c3ttry7nql6odq7ly8texample",
    "created_at": "2024-01-01T00:00:00.000Z",
    "updated_at": "2024-01-01T00:00:00.000Z"
  }
}

400

POST /agreements/:agreement_id/signing_groups Error response

application/json

Schema

Schema

status stringrequired

Possible values: [error]

error objectrequired
code int64required
Possible values: >= 400 and <= 599
message stringrequired
request_id uuidrequired

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "message": "string",
    "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Loading...