POST

Kick a member

/v1/projects/{project}/members/{member}/kick in the Members API.

Moves the member to churned, removes them from every resource and emits member.kicked with the optional reason. Unlike a ban, a kicked member may come back by subscribing again. Answers 200 with the member; a banned member is answered unchanged, since a ban already says more. As with a ban, the connector-side eviction completes in the background after the call returns.

Requires ability

project-user:update

The token must hold this ability, or the call is refused with 403.

Fires one event

Delivered to every endpoint subscribed to it once the change is made.

MCP tool

Runs the same action from an agent, behind the same ability.

Idempotent

Idempotency-Key

Send the header on every call; the same key replays the original response for 24 hours.

Authorization

bearerToken

AuthorizationBearer <token>

A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.

In: header

Path Parameters

project*string

The project, resolved by the route binder.

Formatuuid

member*string

The member, resolved within the project by the route binder.

Formatuuid

Header Parameters

Idempotency-Key*string

A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.

Formatuuid

Request body

JSONWhat the request carriesOptionalapplication/json

Responses

200OKapplication/json

The member after the change.

400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

401UnauthorizedAUTHENTICATION_REQUIREDapplication/json

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.

404Not foundRESOURCE_NOT_FOUNDapplication/json

An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.

409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json

The key was already used in the last 24 hours with a different request body.

422Validation failedVALIDATION_FAILEDapplication/json

The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with error.message saying why and no fields.

425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json

The first request with this key is still running; retry in a few seconds and the original response is replayed.

429Too many requestsRATE_LIMITEDapplication/json

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X POST "https://example.com/v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/members/497f6eca-6276-4993-bfeb-53cbbbba6f08/kick" \  -H "Idempotency-Key: 0199a4ae-6c02-7b5c-9f51-c5f0da5e2f12" \  -H "Content-Type: application/json" \  -d '{}'

{  "data": {    "id": "2a91c4e7-6f38-4b52-8e0d-9c1a7b3f5d80",    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",    "username": "@janedoe",    "first_name": "Jane",    "last_name": "Doe",    "email": null,    "billing_email": "jane@example.com",    "identities": [      {        "id": "6a1f0c3e-2d4b-4e8a-9c7d-1b5e3f9a2c4d",        "connector": "telegram",        "source": "handshake",        "preferred": true,        "notify": false,        "external_id": "123456789",        "display_name": "Jane Doe",        "username": "janedoe",        "linked_at": "2026-05-18T10:05:00Z"      }    ],    "status": "customer",    "joined_at": "2026-05-18T10:05:00Z",    "created_at": "2026-05-18T10:05:00Z",    "updated_at": "2026-05-18T10:05:00Z"  }}

Type definitions

The shapes above as types, ready to paste into your client.

Request

export interface Request {  reason?: string;}

Response

export interface Response {  data: MemberResource;}export interface MemberResource {  id: string;  project_id: string;  username: string;  first_name: string;  last_name: string;  email?: string | null;  billing_email?: string | null;  identities?: MemberIdentityResource[];  status: string | "lead" | "trialing" | "customer" | "churned" | "banned";  joined_at: string | null;  created_at: string | null;  updated_at: string | null;}export interface MemberIdentityResource {  id: string;  connector: string;  source: string;  preferred: boolean;  notify: boolean;  external_id: string;  display_name: string | null;  username: string | null;  linked_at: string;}

How is this guide?

Last updated on October 3, 2026 at 05:57 UTC

Ban a member

/v1/projects/{project}/members/{member}/ban in the Members API.

Unban a member

/v1/projects/{project}/members/{member}/unban in the Members API.