SHshorebird
users

Update the signed-in user.

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.

patch/users/me

Request

  • Base URL
    https://api.shorebird.dev/api/v1
  • Auth
    • HTTP bearer
    • or HTTP bearer

Request body

display_namestring

The user's new display name. At most 256 characters.

patch_overage_limitinteger 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

The user was updated.

Changes

No recorded changes to this operation across all 1 revision of this API.