Users

Deactivates an account: it can no longer sign in and stops counting as a seat.

Requires ManageUsers and an Idempotency-Key; no body. Same rules as PATCH { "isActive": false } - an Organization Admin needs a removal request instead. Already inactive → 200 unchanged. Example: POST /api/v1/users/8f0c3c1e-2b6d-4c55-9a51-0d3f3c1b7e21/deactivate.

post/api/v1/users/{id}/deactivate

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/users/{id}/deactivate
  • Auth: HTTP bearer

Path parameters

idstring required

User id (string GUID).

Response

The account after the change.

idstring

User id (string GUID). Example: "8f0c3c1e-2b6d-4c55-9a51-0d3f3c1b7e21".

emailstring nullable

Login e-mail address. Example: "sam@example.com".

firstNamestring nullable

First name. Example: "Sam".

lastNamestring nullable

Last name. Example: "Carter".

displayNamestring

Display name, e.g. "Sam Carter"; falls back to the e-mail address when no name is recorded.

isActiveboolean

False when the account is deactivated (it cannot sign in and holds no seat).

rolestring nullable

Highest standard role the account holds — OrganizationAdmin, Manager or User (SystemAdmin for platform staff); null when it holds only custom roles.

customRoleIdsinteger[]

Ids of the custom roles the account holds (see /api/v1/roles). Empty when none.

permissionsstring[]

Effective permissions from all of the account's roles, in catalog order. Example: ["ViewInventory", "ViewJobs"].

Changes

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