Update user email preferences

Updates the email preferences for a user.

PATCH/v3/me/email-preferences
JWT

Request Body Schema

PropertyTypeDescriptionConstraints
metrics*booleanIndicates whether to email user metrics.

Request Example

{
  "metrics": true
}
Triggers webhook: user.emailPreference.updated
POST <your-webhook-url>
{
  "event": "user.emailPreference.updated",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "role": "string",
    "twoFactorEnabled": true,
    "googleSsoEnabled": true,
    "lastLoginAt": "2019-08-24T14:15:22Z",
    "company": "string"
  },
  "triggeredAt": "string"
}

Responses

200 OK
{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "role": "string",
  "twoFactorEnabled": true,
  "googleSsoEnabled": true,
  "lastLoginAt": "2019-08-24T14:15:22Z",
  "company": "string"
}