API Reference

Suspend User

Suspend a user account. The handler revokes every active session, blocks new logins, and writes an audit row with the suspending actor and reason. Suspended users keep their data; reactivation restores access.

POST/api/v1/users/{user_id}/suspend

Authentication

Accepts a JWT bearer token (Authorization: Bearer eyJ…) or an API key (X-API-Key: ms_live_…). API-key callers should send X-Project-ID unless the key is project-locked. Cross-tenant operators must send X-Tenant-ID.

Path parameters

Field	Type	Required	Description
`user_id`	`integer`	required	User to suspend. Cannot be the organisation owner.

Query parameters

Field	Type	Required	Description
`organization_id`	`integer`	optional	Organisation context.
`actor_id`	`integer`	optional	User performing the action (defaults to JWT subject).

Request body

Field	Type	Required	Description
`reason`	`string`	required	Stored on the audit row.

request.json

{
  "reason": "policy_violation"
}

Response

Returns 200 OK with the following body.

Field	Type	Required	Description
`user_id`	`integer`	optional	Suspended user id.
`status`	`string`	optional	Always `suspended`.
`sessions_revoked`	`integer`	optional	Number of sessions invalidated.
`suspended_at`	`string`	optional	RFC 3339 UTC.

200.json

{
  "user_id": 4271,
  "status": "suspended",
  "sessions_revoked": 3,
  "suspended_at": "2026-05-04T12:30:11Z"
}

Errors

Status	Code	Description
400	`validation_error`	Body or query failed schema validation. The error includes the offending `field` name.
401	`unauthenticated`	Missing or invalid bearer token / API key.
403	`forbidden`	Authenticated principal lacks the required scope, role, or project access.
404	`not_found`	Target resource does not exist or is not visible to the calling tenant.
429	`rate_limited`	Per-IP or per-route limit exceeded. Respect the `Retry-After` header.
500	`internal_error`	Unhandled server error. Quote the `request_id` when contacting support.

Examples

cURL

curl -X POST https://api.memorysync.io/api/v1/users/EXAMPLE_ID/suspend \
  -H "Authorization: Bearer $MEMORYSYNC_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "policy_violation"
}'

javascript

import { MemorySync } from 'memorysync'

const client = new MemorySync({ apiKey: process.env.MEMORYSYNC_KEY })

const result = await client.request({
  method: 'POST',
  path: '/api/v1/users/EXAMPLE_ID/suspend',
  body: {
    "reason": "policy_violation"
  },
})
console.log(result)

python

from memorysync import Client

client = Client(api_key=os.environ["MEMORYSYNC_KEY"])

result = client.request(
    method="POST",
    path="/api/v1/users/EXAMPLE_ID/suspend",
    json={
      "reason": "policy_violation"
    },
)
print(result)

Behavior & notes

Idempotent through Idempotency-Key on writes. Replays within 24h return the original response unchanged.

← Previous

Get User Profile

Remove User