Skip to main content
POST
auth.user.update

Authorizations

Authorization
string
header
required

A Lath API key: lath_live_sk… or lath_test_sk… on a server, lath_live_pk… or lath_test_pk… in a browser.

Headers

Idempotency-Key
string

Replays the stored response for the same key and input; refuses different input.

Body

application/json
userId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
displayName
string | null
Maximum string length: 120
locale
string | null

The user's language, e.g. 'fr' or 'pt-BR'. Sign-in and other templated messages use the variant for it. Null means unknown.

Maximum string length: 20
custom
object

Response

{ activityId, result }. activityId is empty for reads.

activityId
string
required

The activity this call created, or empty for a read.

result
object
required
Last modified on September 13, 2026