Skip to main content
POST
/
api
/
users
/
{id}
/
archive
Error
A valid request URL is required to generate request examples
{
  "id": 123,
  "email": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z",
  "invitation_pending": true,
  "mfa_enabled": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.spitshake.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Auth-Token
string
header
required

API token generated at Settings > API

Path Parameters

​
id
integer
required

Response

User archived

​
id
integer
​
email
string<email>
​
role
enum<string>
Available options:
admin,
member
​
first_name
string | null
​
last_name
string | null
​
created_at
string<date-time>
​
archived_at
string<date-time> | null
​
invitation_pending
boolean
​
mfa_enabled
boolean

Whether MFA is currently enabled for this user