Skip to content

Update notification preferences

PUT
/api/v1/me/profile/notifications
curl --request PUT \
--url http://localhost:3000/api/v1/me/profile/notifications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "emailNotifications": true, "smsNotifications": true, "pushNotifications": true, "marketingEmails": true }'
Media type application/json
object
emailNotifications

Email notifications enabled

boolean
smsNotifications

SMS notifications enabled

boolean
pushNotifications

Push notifications enabled

boolean
marketingEmails

Marketing emails enabled

boolean
Example generated
{
"emailNotifications": true,
"smsNotifications": true,
"pushNotifications": true,
"marketingEmails": true
}
Media type application/json
object
id
required

User ID

string
email
required

User email

string
name

User display name

string
phone

Phone number

string
timezone
required

Timezone

string
default: UTC
locale
required

Locale

string
default: en
emailNotifications
required

Email notifications enabled

boolean
default: true
smsNotifications
required

SMS notifications enabled

boolean
pushNotifications
required

Push notifications enabled

boolean
default: true
marketingEmails
required

Marketing emails enabled

boolean
bio

User bio

string
jobTitle

Job title

string
department

Department

string
location

Location

string
createdAt
required

Created at

string format: date-time
updatedAt
required

Updated at

string format: date-time
lastLoginAt

Last login timestamp

string format: date-time
isSuperAdmin
required

Whether the user is a super admin

boolean
roles
required

Effective roles for the current user

Array<string>
Example
{
"timezone": "UTC",
"locale": "en",
"emailNotifications": true,
"smsNotifications": false,
"pushNotifications": true,
"marketingEmails": false,
"isSuperAdmin": false,
"roles": [
"admin"
]
}