---
title: "Update the signed-in user."
method: PATCH
path: "/users/me"
tags: ["users"]
---

# Update the signed-in user.

`PATCH /users/me`

## Request

- Base URL: `https://api.shorebird.dev/api/v1`
- URL: `https://api.shorebird.dev/api/v1/users/me`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Changes the signed-in user's display name, patch overage limit, or
both. A field left out of the body is left unchanged. Both fields
are validated before either is written, so a request that is
refused changes nothing; a request that fails partway (a `424`)
may have saved the display name.

Changing `patch_overage_limit` needs a signed-in session that is
not narrowed to a subset of permissions: an API key is refused
with a `403` (`personal_access_token_forbidden`), and a narrowed
session with `api_key_insufficient_permissions`.

## Request body

- UpdateUserRequest: The request body for PATCH /users/me. A field left out is left unchanged.
  - `display_name` string: The user's new display name. At most 256 characters.
  - `patch_overage_limit` integer, nullable: The most patch installs past the plan's allotment the user agrees to pay for each overage period. `0` turns overage off; `null` removes the limit. Must not be negative.

## Response `204`

The user was updated.

## Other responses

- `400`: A field has the wrong type (`user_update_error`), the overage limit is negative (`user_update_overage_invalid`), or the display name is longer than 256 characters (`user_update_display_name_invalid`).
- `401`: An `Authorization` header was sent but its credential is invalid or expired (`user_get_unauthorized`).
- `403`: The overage limit cannot be changed: the credential is an API key (`personal_access_token_forbidden`) or a narrowed session (`api_key_insufficient_permissions`), the plan is a negotiated enterprise plan whose overage is set by the account team (`user_update_overage_negotiated`), or the plan is Hobby, on which only `0` is accepted (`shorebird_plan_insufficient_tier`).
- `404`: No user is signed in (`user_get_user_not_found`).
- `424`: Reading the plan or writing the change failed (`user_update_error`), or enabling overage billing for an annual plan failed (`user_update_overage_provisioning_error`).
- `default`: Standard error response. Emitted for any non-2xx status where a body can be decoded into an [ErrorResponse].

---

[API](https://skmtc.dev/shorebird/apis/shorebird-codepush-api.md) - [All operations](https://skmtc.dev/shorebird/apis/shorebird-codepush-api/llms.txt) - [OpenAPI document](https://skmtc.dev/shorebird/apis/shorebird-codepush-api/revisions/941da8871d10?raw)