latestOpenAPI 3.0.02026-08-081631260.8 KB
ae9d64e51a99
Documents
Update a document
Updates a document. Only drafts and stored contracts can be updated.
patch/documents/{id}
Path parameters
idstring uuid required
Example:1e013958-867e-43fb-8210-c98ab139beb6
Document ID
Request body
Example request
{
"document": {
"attachments": [
{
"filename": "Document attachment 1",
"original": "https://example.com/image.png",
"preview": [
"https://example.com/preview.png"
]
}
],
"attachments_signed_separately": true,
"language": "en",
"message": {
"content": "Hello!"
},
"parties": [
{
"address": "123 Main Street",
"name": "Jane Doe",
"reference": "Sender",
"signees": [
{
"full_name": "Jane Doe",
"signature_verification_methods": [
"sms",
"basic",
"wet_signature"
],
"title": "Software Engineer"
}
]
}
],
"signing_order_mode": "random",
"tags": [
"tags"
],
"to_be_signed_by": "owner_and_others"
}
}Response
Document
Example response
{
"document": {
"attachments": [
{
"original": "https://example.com/image.png",
"preview": [
"https://example.com/preview.png"
]
}
],
"comments": [
{
"account": {
"profile": {
"full_name": "Jane Doe"
}
}
}
],
"language": "uk",
"ocr_status": "pending",
"owner": {
"full_name": "Jane Doe"
},
"parties": [
{
"address": "123 Main Street",
"name": "Jane Doe",
"reference": "Sender",
"signees": [
{
"full_name": "Jane Doe",
"signature_verification_methods": [
"sms",
"basic",
"wet_signature"
],
"title": "Software Engineer"
}
]
}
],
"signing_order_mode": "grouped",
"tags": [
"tags"
],
"visibilities": [
{
"full_name": "Jane Doe"
}
]
}
}