Update role notification settings | Comp AI API

Update role notification settings in Comp AI. Manage organization profile data, API keys, logos, ownership, role notifications, and access approval settings.

PUT /v1/organization/role-notifications

Update role notification settings

cURL

curl --request PUT \
  --url https://api.trycomp.ai/v1/organization/role-notifications \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "settings": [
    {
      "role": "<string>",
      "policyNotifications": true,
      "taskReminders": true,
      "taskAssignments": true,
      "taskMentions": true,
      "weeklyTaskDigest": true,
      "findingNotifications": true
    }
  ]
}
'

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    settings: [
      {
        role: '<string>',
        policyNotifications: true,
        taskReminders: true,
        taskAssignments: true,
        taskMentions: true,
        weeklyTaskDigest: true,
        findingNotifications: true
      }
    ]
  })
};

fetch('https://api.trycomp.ai/v1/organization/role-notifications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.trycomp.ai/v1/organization/role-notifications"

payload = { "settings": [
        {
            "role": "<string>",
            "policyNotifications": True,
            "taskReminders": True,
            "taskAssignments": True,
            "taskMentions": True,
            "weeklyTaskDigest": True,
            "findingNotifications": True
        }
    ] }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

Authorizations

X-API-Key · string · header · required

API key for authentication

Body

application/json

settings · object[] · required

Show child attributes

Response

200 - undefined