Update contract import item
curl --request PATCH \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/contract_imports/{contract_import_id}/items/{id} \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"proposal": {
"document_kind": "<string>",
"property": {},
"lease": {},
"management": {},
"parties": [
{
"role": "<string>",
"name": "<string>",
"document_type": "<string>",
"document_ref": "<string>",
"email_ref": "<string>",
"phone_ref": "<string>"
}
]
}
}
'const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
proposal: {
document_kind: '<string>',
property: {},
lease: {},
management: {},
parties: [
{
role: '<string>',
name: '<string>',
document_type: '<string>',
document_ref: '<string>',
email_ref: '<string>',
phone_ref: '<string>'
}
]
}
})
};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/contract_imports/{contract_import_id}/items/{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_imports/{contract_import_id}/items/{id}"
payload = { "proposal": {
"document_kind": "<string>",
"property": {},
"lease": {},
"management": {},
"parties": [
{
"role": "<string>",
"name": "<string>",
"document_type": "<string>",
"document_ref": "<string>",
"email_ref": "<string>",
"phone_ref": "<string>"
}
]
} }
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": 123,
"source_name": "<string>",
"status": "<string>",
"document_kind": "<string>",
"proposal": {},
"proposal_digest": "<string>",
"warnings": [
"<string>"
],
"refusal": "<string>",
"error": "<string>",
"property_id": 123,
"property_manager_id": 123,
"created_at": 123
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{}{}Contract Imports
Update contract import item
Correct a proposal still in review (ready) before approving it. Applied or scheduled items cannot be edited.
PATCH
/
api
/
v1
/
accounts
/
{account_id}
/
contract_imports
/
{contract_import_id}
/
items
/
{id}
Update contract import item
curl --request PATCH \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/contract_imports/{contract_import_id}/items/{id} \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"proposal": {
"document_kind": "<string>",
"property": {},
"lease": {},
"management": {},
"parties": [
{
"role": "<string>",
"name": "<string>",
"document_type": "<string>",
"document_ref": "<string>",
"email_ref": "<string>",
"phone_ref": "<string>"
}
]
}
}
'const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
proposal: {
document_kind: '<string>',
property: {},
lease: {},
management: {},
parties: [
{
role: '<string>',
name: '<string>',
document_type: '<string>',
document_ref: '<string>',
email_ref: '<string>',
phone_ref: '<string>'
}
]
}
})
};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/contract_imports/{contract_import_id}/items/{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_imports/{contract_import_id}/items/{id}"
payload = { "proposal": {
"document_kind": "<string>",
"property": {},
"lease": {},
"management": {},
"parties": [
{
"role": "<string>",
"name": "<string>",
"document_type": "<string>",
"document_ref": "<string>",
"email_ref": "<string>",
"phone_ref": "<string>"
}
]
} }
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": 123,
"source_name": "<string>",
"status": "<string>",
"document_kind": "<string>",
"proposal": {},
"proposal_digest": "<string>",
"warnings": [
"<string>"
],
"refusal": "<string>",
"error": "<string>",
"property_id": 123,
"property_manager_id": 123,
"created_at": 123
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{}{}Authorizations
Path Parameters
ID of the import item
The numeric ID of the account
Body
application/json
Show child attributes
Show child attributes
Response
Success
pending, ready, scheduled, applied, discarded, failed
Unix timestamp