Member Tools

Ban a project member. Delegates to an Action so cache invalidation runs and a member.banned event emits with the optional reason. Removal from the gated places runs on the connector's pipeline. Noop when the member is already banned.

Queue a message through the project's connector to a segment of its members. The send runs in the background at the pace the connector declares (28 messages a second on Telegram); the tool returns the audience it resolved and how many members it will reach.

Not idempotent — calling twice sends twice. There is no de-duplication, because two identical broadcasts minutes apart is a legitimate thing a creator may want.

Turns the id a bot or a server hands over into a Subscriby member: give it the project, the connector the account lives on and the platform's own id for the account, and it answers the same row get_subscriber does, with the member's connected accounts embedded as identities[]. This is the lookup for a workflow that starts from a platform event (a message, a join, a role change) and needs to know which member, if any, that account belongs to. An account nobody in the project has connected is RESOURCE_NOT_FOUND, indistinguishable from an unknown project, so a caller never learns whether an id exists elsewhere. The REST twin is the identity filter on GET /v1/projects/{project}/members, which returns a one-row page instead.

Fetch one member (subscriber) of a project by id when you already know it — from a webhook payload's subscriber_id, a support conversation, or an earlier list. The row is the one list_subscribers returns, so a member read here is identical to the same member read from the list.

Kick a project member without a permanent ban. Status rolls to churned; removal from the gated places happens on the connector's pipeline. The subscriber can re-join via a fresh purchase or access code later. Delegates to an Action so cache invalidation runs and member.kicked emits with the optional reason.

Lists a member's connected accounts on the connectors: the platform (connector), the platform's own id, name and handle for the account, how the link was proven (source) and whether it is the one the project reaches first (preferred). Members connect accounts themselves — from the portal's Account & Recovery screen or by talking to the project's bot — so there is no tool to connect one for them. The same rows are embedded as identities[] in get_subscriber's REST counterpart, GET /v1/projects/{project}/members/{member}.

List members (project subscribers) with optional filters by project_id, status, and a free-text search across name, email and billing email. Results are scoped to the token's team and ordered newest-first.

Read-only. Returns how many members a broadcast would reach, either for one named segment or for every segment at once. Nothing is sent.

Call this before broadcast_message, every time, and show the human the count. An audience that silently resolves to everyone is the one broadcast mistake that cannot be undone.

Lift a ban on a project member. Status moves from banned to churned — if the subscriber still has active subscriptions, the next successful-payment transition promotes them to customer automatically. Delegates to an Action so cache invalidation runs.

Disconnects one of a member's connected accounts on the creator's behalf: the account no longer signs the member in to the portal, and the project's bot no longer knows them by it. The same recovery rule the portal applies to the member holds here — the account cannot be removed when it is the member's last way to sign in (no verified email, linked Google account or other connected account remains). Emits member.identity_unlinked. Destructive and not idempotent: a second call answers RESOURCE_NOT_FOUND.