Update current user email notification | Comp AI API

Update current user email notification preferences in Comp AI. Invite and manage workforce members, training status, device compliance, email preferences.

PUT /v1/people/me/email-preferences

Update current user email notification preferences

cURL

curl --request PUT \
  --url https://api.trycomp.ai/v1/people/me/email-preferences \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "preferences": {
    "policyNotifications": true,
    "taskReminders": true,
    "weeklyTaskDigest": true,
    "unassignedItemsNotifications": true,
    "taskMentions": true,
    "taskAssignments": true
  }
}
'

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

fetch('https://api.trycomp.ai/v1/people/me/email-preferences', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.trycomp.ai/v1/people/me/email-preferences"

payload = { "preferences": {
        "policyNotifications": True,
        "taskReminders": True,
        "weeklyTaskDigest": True,
        "unassignedItemsNotifications": True,
        "taskMentions": True,
        "taskAssignments": 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

preferences · object · required

Show child attributes

Response

200 - undefined