TRMNL Octri Demo
PATCH/api/me

Update the authenticated user's profile

Updates the authenticated user's profile, time zone, locale, and account-wide display settings. Supply only the fields you want to change; email, password, and keys are managed on the account page.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

7 body fields

Profile and account-wide display settings to update. Fields omitted from the request are not changed.

account_namestringoptional
The name of the user's account.
first_namestringoptional
The user's first name.
last_namestringoptional
The user's last name.
localestringoptional
The user's locale. Must be a locale supported by the app.
low_battery_notification_emailstringoptional
The email address for low-battery notifications.
time_zonestringoptional
An IANA name or a Rails zone name
title_bar_enabledbooleanoptional
Show the title bar on every screen

3 status codes
200Returns the updated profile and account data, including the submitted changes.
dataobjectoptional
401Returned when the request is not authenticated.
errorstringoptional
422Returned when the submitted locale is not supported by the app.

Error handling

A 401 is returned when the request is not authenticated. A 422 is returned when locale is not supported by the app; time_zone accepts an IANA name or a Rails zone name.