Skip to main content
PUT
/
users
Update User
curl --request PUT \
  --url https://api.example.com/users \
  --header 'Content-Type: application/json' \
  --data '
{
  "notification_preference": "<string>",
  "password": "<string>"
}
'

​
Overview

Update the currently authenticated user’s notification preferences. This endpoint allows users to control when they receive notifications about workflow and job events.

​
Authentication

This endpoint requires:
  • Valid session cookie
  • CSRF token in the X-CSRF-Token header
The user ID is automatically extracted from the session.

​
Request

​
notification_preference
string
required
New notification preference settingOptions:
  • ALL - Receive all notifications (workflow failures, job completions, etc.)
  • FAILURES_ONLY - Only receive notifications about failures
  • NONE - Disable all notifications
​
password
string
New password (optional, not currently implemented)

​
Example Request

curl -X PUT http://localhost:8080/users \
  -H "Content-Type: application/json" \
  -H "Cookie: session=<session_cookie>; csrf=<csrf_token>" \
  -H "X-CSRF-Token: <csrf_token>" \
  -d '{
    "notification_preference": "FAILURES_ONLY"
  }'

​
Response

Returns 204 No Content on success.

​
Error Responses

Status CodeDescription
400Invalid request body or user ID not found
401Invalid or expired session
403Invalid CSRF token
404User not found
500Internal server error

​
Usage Notes

Notification preferences are applied immediately and affect all future notifications for workflows and jobs owned by the user.
The password field is included in the request structure but password changes are not currently implemented. Only notification_preference updates are supported.

Build docs developers (and LLMs) love

Get started for freeTalk to us