Update Submission
curl --request PATCH \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/contract_submissions/{id} \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"contract_submission": {
"status": "<string>",
"property_id": 123
}
}
'const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({contract_submission: {status: '<string>', property_id: 123}})
};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/contract_submissions/{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_submissions/{id}"
payload = { "contract_submission": {
"status": "<string>",
"property_id": 123
} }
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": 123,
"status": "draft",
"template_name": "<string>",
"document_filename": "<string>",
"submitters_order": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"labels": [
{}
],
"contract_template": {
"id": 123,
"name": "<string>",
"slug": "<string>",
"status": "<string>",
"fields": [
{}
],
"schema": {},
"submitters": [
{}
],
"preferences": {},
"labels": [
"<string>"
],
"documents": [
{
"id": 123,
"uuid": "<string>",
"filename": "<string>",
"content_type": "<string>",
"signed_uuid": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"contract_submitters": [
{
"id": 123,
"name": "<string>",
"email": "<string>",
"status": "pending",
"signing_order": 123,
"role": "<string>",
"slug": "<string>",
"contact": {
"id": 123,
"name": "<string>",
"email": "<string>",
"avatar_url": "<string>"
}
}
]
}Contract Submissions
Update Submission
Update details of a contract submission (e.g. status, property linkage)
PATCH
/
api
/
v1
/
accounts
/
{account_id}
/
contract_submissions
/
{id}
Update Submission
curl --request PATCH \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/contract_submissions/{id} \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"contract_submission": {
"status": "<string>",
"property_id": 123
}
}
'const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({contract_submission: {status: '<string>', property_id: 123}})
};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/contract_submissions/{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_submissions/{id}"
payload = { "contract_submission": {
"status": "<string>",
"property_id": 123
} }
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": 123,
"status": "draft",
"template_name": "<string>",
"document_filename": "<string>",
"submitters_order": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"labels": [
{}
],
"contract_template": {
"id": 123,
"name": "<string>",
"slug": "<string>",
"status": "<string>",
"fields": [
{}
],
"schema": {},
"submitters": [
{}
],
"preferences": {},
"labels": [
"<string>"
],
"documents": [
{
"id": 123,
"uuid": "<string>",
"filename": "<string>",
"content_type": "<string>",
"signed_uuid": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"contract_submitters": [
{
"id": 123,
"name": "<string>",
"email": "<string>",
"status": "pending",
"signing_order": 123,
"role": "<string>",
"slug": "<string>",
"contact": {
"id": 123,
"name": "<string>",
"email": "<string>",
"avatar_url": "<string>"
}
}
]
}Authorizations
Body
application/json
Show child attributes
Show child attributes
Response
200 - application/json
Success
Available options:
draft, pending, sent, opened, in_progress, viewed, completed, declined, expired, archived Show child attributes
Show child attributes
Show child attributes
Show child attributes