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
  }
}
'

Authorizations

X-API-Key · string · header · required

API key for authentication

Body

application/json

preferences · object · required

Show child attributes

Response

200 - undefined