Skip to content

API Reference / Users

Update a user

Updates the caller's own display name or login email address. The target is always the caller resolved from the session or API key, never a request field, so a caller can never name a different user to update. Only the fields you supply are changed.

POST/accounts.v1.Accounts/UpdateUser

Request body

application/jsonRequired

Request to update the calling user's own profile. Only the display name can change. ChangeEmail changes the email address.

email?string

Must equal the current address, ignoring case, or the request is rejected with invalid_argument. It never changes the address. Absent leaves it unchanged.

name?string

New display name, 1 to 256 characters after trimming. Absent leaves the name unchanged.

Response body

application/json

Success

user?User

The user's updated account details.

Show attributes
avatarUrl?string

URL of the user's avatar image, taken from their linked Discord account. Empty when there is none.

createdAt?string

When the account was created.

Format"date-time"

email?string

The user's email address, stored lowercase and unique across users.

id?string

Opaque 16-byte identifier of the user, assigned when the account is created. Base64-encoded in JSON.

Format"byte" base64

isAdministrator?boolean

True when the user is a platform administrator with access across every workspace.

name?string

The user's display name, 1 to 256 characters.

status?string

The account's status. A suspended user can no longer sign in.

Value in"USER_STATUS_ACTIVE""USER_STATUS_SUSPENDED"

updatedAt?string

When the account was last changed.

Format"date-time"

curl -X POST "https://api.goldmine.to/accounts.v1.Accounts/UpdateUser" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Jordan A. Hale"
  }'
{
  "user": {
    "id": "EjRWeBI0VniQEjRWeBI0Vg==",
    "name": "Jordan A. Hale",
    "email": "jordan@acme.example",
    "status": "active",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-06-29T12:05:00Z"
  }
}