Skip to main content
POST
Block User
Creates a block edge from the acting user (the blocker) to the specified user (the target). Blocking is non-disclosing — the blocked user is never notified and can never tell they’ve been blocked. On a new block, Sublay retroactively tears down the existing relationship between the two users in one transaction: any follow in either direction is removed, and any connection or pending connection request in either direction is removed. Nothing is restored on unblock. See Block enforcement for the full list of what a block prevents and hides.
Requires the moderation bundle. Blocking ships with reporting and suspensions as part of the trust & safety package. A project without the moderation bundle returns 403 database/tables-not-available. See Bundles.

Path Parameters

string
required
The Sublay user ID (UUID) of the user to block (the target).

Body Parameters

string
The user performing the block (the blocker). Only service/master keys may supply an actingUserId other than the caller’s own; with a user token the blocker is derived from the token and this field is ignored.

Response

On a new block, returns HTTP 201 with the created block record. Re-blocking an already-blocked user is an idempotent success and returns HTTP 200 with the existing record.
string
Unique block record ID (UUID).
string
ID of the user who created the block (the acting user).
string
ID of the user being blocked (the target).
string
ISO timestamp of when the block was created.

Error Responses

See Also