Update contract draft
curl --request PATCH \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/contract_drafts/{id} \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"contract_type_id": 123,
"opportunity_id": 123,
"property_id": 123,
"signature_id": "<string>",
"from_opportunity": true,
"authoring": "<string>",
"signed_city": "<string>",
"manual_values": {},
"base": {
"source": "<string>",
"document_id": 123,
"template_id": 123,
"name": "<string>"
},
"signers": [
{
"contact_id": 123,
"role": "<string>",
"from_opportunity": true,
"signature_status": "<string>"
}
],
"conditions": {},
"replace_body": true
}
'const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contract_type_id: 123,
opportunity_id: 123,
property_id: 123,
signature_id: '<string>',
from_opportunity: true,
authoring: '<string>',
signed_city: '<string>',
manual_values: {},
base: {source: '<string>', document_id: 123, template_id: 123, name: '<string>'},
signers: [
{
contact_id: 123,
role: '<string>',
from_opportunity: true,
signature_status: '<string>'
}
],
conditions: {},
replace_body: true
})
};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/contract_drafts/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.yampi.ai/api/v1/accounts/{account_id}/contract_drafts/{id}"
payload = {
"contract_type_id": 123,
"opportunity_id": 123,
"property_id": 123,
"signature_id": "<string>",
"from_opportunity": True,
"authoring": "<string>",
"signed_city": "<string>",
"manual_values": {},
"base": {
"source": "<string>",
"document_id": 123,
"template_id": 123,
"name": "<string>"
},
"signers": [
{
"contact_id": 123,
"role": "<string>",
"from_opportunity": True,
"signature_status": "<string>"
}
],
"conditions": {},
"replace_body": True
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": 123,
"status": "<string>",
"name": "<string>",
"contract_type": {},
"contract_template_id": 123,
"source_document_id": 123,
"source_document": {},
"contract_template": {},
"preparation": {
"status": "<string>",
"error": "<string>"
},
"opportunity": {},
"from_opportunity": true,
"property": {},
"conditions": {},
"signed_city": "<string>",
"manual_values": {},
"variable_values": {},
"signers": [
{}
],
"review_invitation_preview": {},
"signature_id": "<string>",
"base": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{}{
"errors": [
"<string>"
]
}Contract Drafts
Update contract draft
Configure the draft: contract type, property, deal, signers and conditions.
PATCH
/
api
/
v1
/
accounts
/
{account_id}
/
contract_drafts
/
{id}
Update contract draft
curl --request PATCH \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/contract_drafts/{id} \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"contract_type_id": 123,
"opportunity_id": 123,
"property_id": 123,
"signature_id": "<string>",
"from_opportunity": true,
"authoring": "<string>",
"signed_city": "<string>",
"manual_values": {},
"base": {
"source": "<string>",
"document_id": 123,
"template_id": 123,
"name": "<string>"
},
"signers": [
{
"contact_id": 123,
"role": "<string>",
"from_opportunity": true,
"signature_status": "<string>"
}
],
"conditions": {},
"replace_body": true
}
'const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contract_type_id: 123,
opportunity_id: 123,
property_id: 123,
signature_id: '<string>',
from_opportunity: true,
authoring: '<string>',
signed_city: '<string>',
manual_values: {},
base: {source: '<string>', document_id: 123, template_id: 123, name: '<string>'},
signers: [
{
contact_id: 123,
role: '<string>',
from_opportunity: true,
signature_status: '<string>'
}
],
conditions: {},
replace_body: true
})
};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/contract_drafts/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.yampi.ai/api/v1/accounts/{account_id}/contract_drafts/{id}"
payload = {
"contract_type_id": 123,
"opportunity_id": 123,
"property_id": 123,
"signature_id": "<string>",
"from_opportunity": True,
"authoring": "<string>",
"signed_city": "<string>",
"manual_values": {},
"base": {
"source": "<string>",
"document_id": 123,
"template_id": 123,
"name": "<string>"
},
"signers": [
{
"contact_id": 123,
"role": "<string>",
"from_opportunity": True,
"signature_status": "<string>"
}
],
"conditions": {},
"replace_body": True
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": 123,
"status": "<string>",
"name": "<string>",
"contract_type": {},
"contract_template_id": 123,
"source_document_id": 123,
"source_document": {},
"contract_template": {},
"preparation": {
"status": "<string>",
"error": "<string>"
},
"opportunity": {},
"from_opportunity": true,
"property": {},
"conditions": {},
"signed_city": "<string>",
"manual_values": {},
"variable_values": {},
"signers": [
{}
],
"review_invitation_preview": {},
"signature_id": "<string>",
"base": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{}{
"errors": [
"<string>"
]
}Path Parameters
Body
application/json
Response
Success