---
title: "Change the role of a user"
method: PATCH
path: "/apps/{id}/users/{userId}"
tags: ["Apps"]
---

# Change the role of a user

`PATCH /apps/{id}/users/{userId}`

## Request

- Base URL: `https://api.hypamoon.com/api/v1`
- URL: `https://api.hypamoon.com/api/v1/apps/{id}/users/{userId}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://app.hypamoon.com/oauth/authorize`, token URL `https://api.hypamoon.com/oauth/token`, scopes: `sites:write`)

Sets one of the app's roles. The app sees the new role in x-hypamoon-user within seconds.

## Path parameters

- `id` string, uuid, required
- `userId` string, uuid, required

## Request body

- object
  - `role` string, required: One of the app's roles.

## Response `200`

The user with the new role.

- object: Someone who may sign in to the app.
  - `id` string, uuid, required: The person's id: sub in x-hypamoon-user.
  - `email` string, required
  - `name` string, nullable, required
  - `role` string, required
  - `created_at` string, required
  - `last_sign_in_at` string, nullable, required

## Other responses

- `400`: Bad Request: invalid_json.
- `401`: Unauthorized: unauthorized, missing_api_key, invalid_api_key, api_key_revoked, project_deleted.
- `403`: Forbidden: project_not_enabled, key_mode_mismatch, missing_scope, verification_required.
- `404`: Not Found: not_found.
- `409`: Conflict: conflict.
- `422`: Unprocessable Content: validation_failed.
- `429`: Too Many Requests: rate_limited.
- `500`: Internal Server Error: internal_error.
- `503`: Service Unavailable: service_unavailable.

---

[API](https://skmtc.dev/hypamoon/apis/hypamoon-api.md) · [All operations](https://skmtc.dev/hypamoon/apis/hypamoon-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hypamoon/apis/hypamoon-api/revisions/9f0b90004c06?raw)