Skip to content

Block a person​

POST
/users/{id}/block

Blocks a person (App Store Guideline 1.2). id is a profile UUID or handle, with or without @, as on GET /users/{id}. Idempotent: 201 when the block is new, 200 when it already existed.

A block, enforced by the server for every client:

  • the caller stops receiving that person's comments and replies
    (GET /fundraisers/{fundraiserId}/comments) and the commented rows
    of their profile activity;

  • follows between the two are removed in BOTH directions, and neither
    can follow the other while the block stands
    (POST /subscriptions answers 403 USER_BLOCKED);

  • the blocked person cannot comment on the caller's campaigns or reply
    to the caller's comments (403 COMMENTING_BLOCKED).

Nobody is notified. Unblocking does not restore removed follows.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Profile UUID or handle.

Type
string
Required

Responses​

Already blocked; nothing changed

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress