Block a member

Blocks a member in the community associated with your API key. Blocking is permanent. You can’t unblock a member through the API or the dashboard. To reverse a block, contact Community support.

When a member is blocked:

  • They stop receiving messages from your community.
  • They aren’t notified that they’ve been blocked.
  • Messages they send don’t appear in your inbox.

The request takes no body. The response is a Member object, the same one returned by GET /members/{member_id}.

Which members can be blocked

You can only block members who have joined. Blocking a member whose status is new (they haven’t confirmed yet) or opted_out returns a member_state_conflict error.

Retries

This endpoint is idempotent. Blocking a member who’s already blocked doesn’t change anything and returns 200 with the member, so retries are safe.

Path Params
uuid
required

The member's identifier.

Headers
string

Pins the API version for this request as YYYY-MM-DD. Defaults to the version pinned to your
credential.

Responses

Callback
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json