Update a signing group

PUT 
/agreements/:agreement_id/signing_groups/:signing_group_id

Update an existing signing group. The agreement must be in draft or open state.

Request

Path Parameters

agreement_id cuidrequired

PUT /agreements/:agreement_id/signing_groups/:signing_group_id parameter

signing_group_id cuidrequired

PUT /agreements/:agreement_id/signing_groups/:signing_group_id parameter

application/json

Body

PUT /agreements/:agreement_id/signing_groups/:signing_group_id request body

name string
order int64

Possible values: <= 9007199254740991

participants cuid[]

Possible values: non-empty

List of IDs for the participants you wish add to the signing group.

Responses

200

PUT /agreements/:agreement_id/signing_groups/:signing_group_id 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

PUT /agreements/:agreement_id/signing_groups/:signing_group_id 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...