---
title: "Update a portal user"
method: PATCH
path: "/api/v1/admin/portal-users/{portal_user_id}"
tags: ["Admin APIs", "portal-users"]
---

# Update a portal user

`PATCH /api/v1/admin/portal-users/{portal_user_id}`

## Path parameters

- `portal_user_id` string, uuid, required

## Request body

- PortalUserUpdate — Admin request to update a portal user's active status or notes.
  - `is_active` boolean, nullable
  - `notes` string, nullable
  - `portals` PortalUserPortalAssignment[], nullable
    - `portal_key` string, required
    - `meta_data` object

## Response `200`

Successful Response

- PortalUserRead — Admin read response for a portal user.
  - `id` string, uuid, required
  - `okta_user_id` string, required
  - `first_name` string, required
  - `last_name` string, required
  - `email` string, required
  - `is_active` boolean, required
  - `notes` string, nullable, required
  - `portals` PortalUserPortalRead[]
    - `portal_id` string, uuid, required
    - `portal_key` string, required
    - `portal_name` string, required
    - `meta_data` object, required
  - `okta_status` string

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/carbonarc/apis/carbon-arc-client-admin-api.md) · [All operations](https://skmtc.net/carbonarc/apis/carbon-arc-client-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/carbonarc/carbon-arc-client-admin-api/revisions/a8ca30023371/schema)