Comment on contract review
curl --request POST \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/contract_submissions/{contract_submission_id}/reviews/comments \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"version_id": 123,
"kind": "<string>",
"content": "<string>",
"quote": "<string>",
"submitted": true,
"anchor": {
"from": 123,
"to": 123,
"text_from": 123,
"text_to": 123
},
"proposal": {
"condition_key": "<string>",
"value": "<unknown>",
"replacement": "<string>"
}
}
'const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
version_id: 123,
kind: '<string>',
content: '<string>',
quote: '<string>',
submitted: true,
anchor: {from: 123, to: 123, text_from: 123, text_to: 123},
proposal: {condition_key: '<string>', value: '<unknown>', replacement: '<string>'}
})
};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/contract_submissions/{contract_submission_id}/reviews/comments', 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/{contract_submission_id}/reviews/comments"
payload = {
"version_id": 123,
"kind": "<string>",
"content": "<string>",
"quote": "<string>",
"submitted": True,
"anchor": {
"from": 123,
"to": 123,
"text_from": 123,
"text_to": 123
},
"proposal": {
"condition_key": "<string>",
"value": "<unknown>",
"replacement": "<string>"
}
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"submission_id": 123,
"status": "<string>",
"submission_name": "<string>",
"account": {},
"current_version": {},
"versions": [
{}
],
"participants": [
{}
],
"comments": [
{}
],
"current_participant": {},
"read_only": true,
"has_pending_changes": true,
"previous_pending_comments": [
{}
]
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{}{
"error": "<string>"
}{
"error": "<string>"
}Contract Reviews
Comment on contract review
Add a comment, or a proposed change, anchored to the contract text.
POST
/
api
/
v1
/
accounts
/
{account_id}
/
contract_submissions
/
{contract_submission_id}
/
reviews
/
comments
Comment on contract review
curl --request POST \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/contract_submissions/{contract_submission_id}/reviews/comments \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"version_id": 123,
"kind": "<string>",
"content": "<string>",
"quote": "<string>",
"submitted": true,
"anchor": {
"from": 123,
"to": 123,
"text_from": 123,
"text_to": 123
},
"proposal": {
"condition_key": "<string>",
"value": "<unknown>",
"replacement": "<string>"
}
}
'const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
version_id: 123,
kind: '<string>',
content: '<string>',
quote: '<string>',
submitted: true,
anchor: {from: 123, to: 123, text_from: 123, text_to: 123},
proposal: {condition_key: '<string>', value: '<unknown>', replacement: '<string>'}
})
};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/contract_submissions/{contract_submission_id}/reviews/comments', 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/{contract_submission_id}/reviews/comments"
payload = {
"version_id": 123,
"kind": "<string>",
"content": "<string>",
"quote": "<string>",
"submitted": True,
"anchor": {
"from": 123,
"to": 123,
"text_from": 123,
"text_to": 123
},
"proposal": {
"condition_key": "<string>",
"value": "<unknown>",
"replacement": "<string>"
}
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"submission_id": 123,
"status": "<string>",
"submission_name": "<string>",
"account": {},
"current_version": {},
"versions": [
{}
],
"participants": [
{}
],
"comments": [
{}
],
"current_participant": {},
"read_only": true,
"has_pending_changes": true,
"previous_pending_comments": [
{}
]
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Path Parameters
ID of the contract submission
The numeric ID of the account
Body
application/json
Response
Success
Was this page helpful?