Update document relevance setting
curl --request PATCH \
--url https://api.trycomp.ai/v1/evidence-forms/{formType}/settings \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"isNotRelevant": true
}
'const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({isNotRelevant: true})
};
fetch('https://api.trycomp.ai/v1/evidence-forms/{formType}/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.trycomp.ai/v1/evidence-forms/{formType}/settings"
payload = { "isNotRelevant": True }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)Evidence Forms
Update document relevance setting | Comp AI API
Update document relevance setting in Comp AI. Collect, review, upload, and export structured evidence submissions for compliance tasks and document.
PATCH
/
v1
/
evidence-forms
/
{formType}
/
settings
Update document relevance setting
curl --request PATCH \
--url https://api.trycomp.ai/v1/evidence-forms/{formType}/settings \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"isNotRelevant": true
}
'const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({isNotRelevant: true})
};
fetch('https://api.trycomp.ai/v1/evidence-forms/{formType}/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.trycomp.ai/v1/evidence-forms/{formType}/settings"
payload = { "isNotRelevant": True }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)Authorizations
API key for authentication
Headers
Organization ID (required for session auth, optional for API key auth)
Path Parameters
Slug of the evidence form. Call GET /v1/evidence-forms to see every form with its title.
Available options:
board-meeting, it-leadership-meeting, risk-committee-meeting, meeting, access-request, whistleblower-report, penetration-test, rbac-matrix, infrastructure-inventory, employee-performance-evaluation, network-diagram, tabletop-exercise, account-types Body
application/json
True marks the form as not applicable to this organization, so it stops counting as missing evidence.
Example:
true
Response
200 - undefined
Was this page helpful?