Update a control
curl --request PATCH \
--url https://api.trycomp.ai/v1/controls/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "Access Control",
"description": "Manages user access to systems",
"lastReviewDate": "2023-11-07T05:31:56Z",
"nextReviewDate": "2023-11-07T05:31:56Z"
}
'const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Access Control',
description: 'Manages user access to systems',
lastReviewDate: '2023-11-07T05:31:56Z',
nextReviewDate: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.trycomp.ai/v1/controls/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.trycomp.ai/v1/controls/{id}"
payload = {
"name": "Access Control",
"description": "Manages user access to systems",
"lastReviewDate": "2023-11-07T05:31:56Z",
"nextReviewDate": "2023-11-07T05:31:56Z"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)Controls
Update a control | Comp AI API
Updates org-editable control fields (name, description, review dates). Edits on template-managed controls are preserved by framework syncs. Use to reword.
PATCH
/
v1
/
controls
/
{id}
Update a control
curl --request PATCH \
--url https://api.trycomp.ai/v1/controls/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "Access Control",
"description": "Manages user access to systems",
"lastReviewDate": "2023-11-07T05:31:56Z",
"nextReviewDate": "2023-11-07T05:31:56Z"
}
'const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Access Control',
description: 'Manages user access to systems',
lastReviewDate: '2023-11-07T05:31:56Z',
nextReviewDate: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.trycomp.ai/v1/controls/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.trycomp.ai/v1/controls/{id}"
payload = {
"name": "Access Control",
"description": "Manages user access to systems",
"lastReviewDate": "2023-11-07T05:31:56Z",
"nextReviewDate": "2023-11-07T05:31:56Z"
}
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
Path Parameters
Unique control identifier
Example:
"ctl_abc123def456"
Body
application/json
Control name
Example:
"Access Control"
Control description
Example:
"Manages user access to systems"
When this control was last reviewed. Pass null to clear. Strict calendar validation is enforced: rollover dates like 2024-02-30 are rejected with a 400.
When this control is next due for review. Pass null to clear. Strict calendar validation is enforced: rollover dates like 2024-02-30 are rejected with a 400.
Response
200
Was this page helpful?

