Members

Ban a member

curl -X POST https://api.subscriby.net/v1/projects/$PROJECT_ID/members/$MEMBER_ID/ban \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"reason": "Repeated spam in the research channel."}'

Moves a lead, customer, trialing or churned member to banned, removes their access on every connector and emits member.banned with the optional reason. Answers 200 with the member; a member already banned is answered unchanged and emits nothing.

Connector-side eviction (kicks from the gated spaces, revoked invite links) runs asynchronously on the connector pipeline after the flip. The call returns as soon as Subscriby's state has been updated and the webhook event has been fired; the platform actions complete in the background.

post/v1/projects/{project}/members/{member}/ban

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/projects/{project}/members/{member}/ban
  • Auth: HTTP bearer

Path parameters

projectstring uuid required

The project, resolved by the route binder.

memberstring uuid required

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

Headers

Idempotency-Keystring uuid required

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.

Request body

reasonstring

Why the member is banned; carried on the member.banned event and shown in the dashboard, never sent to the member.

Response

The member after the change.

Example response

{
  "data": {
    "id": "2a91c4e7-6f38-4b52-8e0d-9c1a7b3f5d80",
    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",
    "username": "@janedoe",
    "first_name": "Jane",
    "last_name": "Doe",
    "billing_email": "jane@example.com",
    "identities": [
      {
        "id": "6a1f0c3e-2d4b-4e8a-9c7d-1b5e3f9a2c4d",
        "connector": "telegram",
        "source": "handshake",
        "preferred": true,
        "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"
  }
}

Changes

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