PUT user/{userId}

Related

Update a user's info. Currently, only avatar and profile information can be changed with this method (not username or email).

Although this is not currently enforced at the API, it is assumed that the information passed for the user's public profile will be a subset of the information passed for the user's full profile. (This may be enforced in the future.)

Example

PUT /methods/v1/user/66a5db1f-2785-498d-9068-e24ddbba03f2 HTTP/1.1
Authorization: Bearer ...
Content-Type: application/json

{
  "avatar": "protected/us-west-2:5f40aa7b-817d-4a9d-a92f-5cbfad3e6dc2/c8cd93ea-5190-4796-9161-65349add3d1e.png",
  "emblem": "66a5db1f-2785-498d-9068-e24ddbba03f2",
  "fullProfile": {
    "profile": "This is my profile."
  },
  "publicProfile": {
    "profile": "This is my profile."
  }
}
----------------------------------------
HTTP/1.1 204 No Content
ETag: W/"a-bAsFyilMr4Ra1hIU5PyoyFRunpI"

Security

Authentication is required for this method, and access is restricted to admins and to the user themself.

URL Parameters

NameDescriptionValue
userIdthe ID of the user as a GUID with dashesstring

Query Parameters

NONE

Request Body

NameDescriptionValue
avatara media path to the user's avatar image file; will be null if no avatar has been setstring or null
emblemthe GUID of an emblem to display with the user's avatar, or null if none is selectedstring or null
fullProfilethe user's full profileobject; see Profile
publicProfilethe user's public profile; fields are a subset of full profile based on each field's public visibility settingobject; see Profile

Profile

NameDescriptionValue
profilea text description of this user, if public optionalstring

Response

Successful responses are code 204. Error responses are standard.

Response Body

NONE