Batch create participants
POSThttps://api.zigned.se/rest/v3/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
Responses
- 200
- 400
POST /agreements/:agreement_id/participants/batch Successful response
- application/json
- Schema
- Example (from 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
{
"version": "1.0",
"result_type": "list",
"resource_type": "participant",
"data": [
{
"id": "ckkxdwxea34r9exlwv7example",
"resource_type": "participant",
"name": "Jane Doe",
"email": "jane.doe@example.com",
"status": "draft",
"order": 1,
"signing_group": "cae4dlkykruvmbylwzoexample",
"agreement": "cid0a8ikvljx6pb6qkoexample",
"signing_room_url": "https://www.zigned.se/sign/cjxkxz2rkpwgp2p9jrdexample/ci9dzwg6pdmxxz3bwojexample",
"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"
}
]
}
POST /agreements/:agreement_id/participants/batch Error response
- application/json
- Schema
- Example (from schema)
Schema
status stringrequired
Possible values: [error
]
error objectrequired
{
"status": "error",
"error": {
"code": 0,
"message": "string",
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
}
Authorization: http
name: HTTP_1type: httpscheme: bearer
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X POST 'https://api.zigned.se/rest/v3/agreements/:agreement_id/participants/batch' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"participants": [
{
"email": "string",
"name": "string",
"role": "signer",
"personal_number": "string",
"order": 0
}
]
}'