---
title: "Offboard User"
method: POST
path: "/admin/users/{user_id}/offboard"
tags: ["admin", "users"]
---

# Offboard User

`POST /admin/users/{user_id}/offboard`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/admin/users/{user_id}/offboard`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Revoke a departed employee's access and remove them from internal lists.

Disables the PropelAuth account, then soft-deletes ``auth.user``. Both are needed:
soft-deleting alone hides someone who can still sign in, and disabling alone leaves
them in every internal work-list permanently.

Idempotent — offboarding an already-offboarded user returns them unchanged.

## Path parameters

- `user_id` string, required

## Headers

- `organization-id` string, nullable
- `timezone` string
- `x-user-id` string, nullable
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Response `200`

Successful Response

- User

## Other responses

- `422`: Validation Error

---

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