Lift a ban

POST

/staff/people/{id}/unban

curl --request POST \
  --url https://api.sloose.com/staff/people/c1d2e3f4/unban \
  --header 'Authorization: Bearer <token>'

• Production

Backoffice route: a staff session, or ADMIN_TOKEN. They can sign in again, into whichever organisations they still belong to. Their old sessions are not restored — those were deleted when the ban went on. Written down as user.unban.

Authorizations

• sessionAuth
• adminToken

Parameters

Path Parameters

id

required

The person

string

Example

c1d2e3f4

The person

Responses

200

The ban is lifted.

Media typeapplication/json

A write that carries nothing back.

object

ok

required

boolean

Example

{
  "ok": true
}

401

A bearer that is neither the token nor a live session (code: AUTH_REQUIRED).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

403

A customer’s session, an API token, or no bearer at all — not staff, and not the ADMIN_TOKEN (code: ADMIN_REQUIRED).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

404

No such banned person, or it is not visible to this session.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

503

The restore switch is on (code: MAINTENANCE): every route but /health and /robots.txt is refused before anything is read, except the operator’s own POST /staff/people/{id}/delete with the ADMIN_TOKEN. Sloose is down for maintenance. Please try again in a few minutes.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed value: MAINTENANCE

Example

{
  "code": "MAINTENANCE"
}

Headers

Retry-After

integer

Seconds until asking again is worth it (300 while the switch is on).