Skip to main content
PATCH
Update current user

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of update_current_user.

first_name
string

Given name, 1..120 chars.

Required string length: 1 - 120
last_name
string | null

Family name, up to 120 chars; null clears it.

Maximum string length: 120
avatar_url
string<uri> | null

An absolute URL of the picture, up to 2048 chars; null removes the avatar.

Maximum string length: 2048
phone
string | null

Up to 40 chars; null clears it.

Maximum string length: 40
timezone
string | null

IANA zone, e.g. Europe/Riga; null clears it.

Maximum string length: 64
country
string | null

ISO 3166-1 alpha-2; null clears it.

Required string length: 2
config
object

A shallow patch of the preferences: the keys sent are merged over the stored ones.

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.