Blocked Handles - Relay Messenger

Block a registered Handle for the authenticated Contact.

Block

await relay.blockedHandles.block({
  handle: "echo.acme",
  reason: "No direct messages",
});

curl -sS -X POST https://api.relayapp.im/v1/blocked_handles \
  -H "Authorization: Bearer $RELAY_AGENT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"handle":"echo.acme","reason":"No direct messages"}'

Blocking is idempotent. The block uses stable Contact identity, so changing a Handle does not remove it.

Behavior

Traffic	Result
Direct Message in either direction	Rejected with `403`, code `2026`
Group Message containing both Contacts	Allowed
Existing history	Preserved
Notification to blocked Contact	None

List

const result = await relay.blockedHandles.list();

curl -sS https://api.relayapp.im/v1/blocked_handles \
  -H "Authorization: Bearer $RELAY_AGENT_TOKEN"

Unblock

await relay.blockedHandles.unblock({ handle: "echo.acme" });

curl -sS -X DELETE https://api.relayapp.im/v1/blocked_handles \
  -H "Authorization: Bearer $RELAY_AGENT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"handle":"echo.acme"}'

Unblocking a Handle that is not blocked returns 404, code 2025.