Batch create participants

POST 
/agreements/:agreement_id/participants/batch

Batch creates new participants in draft status. Use the participant IDs in subsequent requests.

Request

Path Parameters

agreement_id cuidrequired

POST /agreements/:agreement_id/participants/batch parameter

application/json

Body

POST /agreements/:agreement_id/participants/batch request body

participants object[]required
Array [
email string
The email of the participant. Will be used in all communication, if email communication is enabled for the agreement.
name string
The name of the participant. If omitted, the email adress will be used as name.
role string
Possible values: [signer, approver]
Default value: signer
The role of the participant within the signing process. If the agreement is configured for qualified signatures, only "signer" is supported. Default role is "signer".
personal_number string
The personal number of the participant. If provided, the signer will have to use an advanced signing method that supports a swedish personal number to sign the agreement and only be allowed to sign if the personal number matches what is provided. Only available for signers.
locale string
Possible values: [sv-SE, en-US]
Default value: sv-SE
Optional. The locale for the participant. Can be overridden by the participant when signing, but the locale provided by you will serve as the default in initial communication. If not specified, the default locale for the agreement will be used.
order int64
Possible values: >= -9007199254740991 and <= 9007199254740991
Only applicable if signing order is enabled for the agreement. It specifies the order in the signing queue this participant will have. Will be put last in line if not specified. If multiple participants share the same queue number, this participant will take precendent and the rest will be moved forward accordingly.
]

Responses

200

POST /agreements/:agreement_id/participants/batch Successful response

application/json

Schema

Schema

version stringrequired

Possible values: [1.0]

The version of the response schema

result_type stringrequired

Possible values: [list]

A non-paginated list of the participant resource.

resource_type stringrequired

Possible values: [participant]

Data contains the participant resource.

data object[]required

Example (from schema)

{
  "version": "1.0",
  "result_type": "list",
  "resource_type": "participant",
  "data": [
    {
      "id": "cfd5yqmm1r2pxx3xxqkexample",
      "resource_type": "participant",
      "name": "Jane Doe",
      "email": "jane.doe@example.com",
      "status": "draft",
      "order": 1,
      "signing_group": "clgm69qfjmzol7bmhjmexample",
      "agreement": "cb7h8p2jva2kaktidnbexample",
      "signing_room_url": "https://www.zigned.se/sign/cvoppq9maacmsg0uh5nexample/c5keltbncihl7floagsexample",
      "locale": "sv-SE",
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-01T00:00:00.000Z",
      "role": "approver",
      "decision_made_at": "2024-01-01T00:00:00.000Z"
    }
  ]
}

400

POST /agreements/:agreement_id/participants/batch 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...