---
title: "Block a user"
method: POST
path: "/v3/users/{user_id}/block"
tags: ["Moderation"]
---

# Block a user

`POST /v3/users/{user_id}/block`

## Request

- Base URL: `https://api-APP_ID.sendbird.com`
- URL: `https://api-APP_ID.sendbird.com/v3/users/{user_id}/block`
- Auth: none declared

## Block a user

A user can block another user if the user doesn't wish to receive any messages or notifications from the blocked user in a 1-to-1 group channel. In a 1-to-N group channel, the user can still receive messages from the blocked user, but this depends on the UI settings of the chat view. In any case, notifications from the blocked user won't be delivered to the 1-to-N group channel. You can choose whether or not the user can view [which users are blocked](https://sendbird.com/docs/chat/platform-api/v3/moderation/listing-blocked-and-blocking-users/list-blocked-and-blocking-users) in the channel UI.

Sendbird application provides two blocking options: include or exclude blocked users when sending invitations, and turn on or off notifications from blocked users. [Explicit and classic block modes](https://sendbird.com/docs/chat/platform-api/v3/deprecated#2-explicit-and-classic-block-modes) have been deprecated and are only supported for customers who started using them before they were deprecated.

- **Include or exclude blocked users when sending invitations**: Determines whether or not to automatically filter out blocked users when a user invites a group of users to a new group channel. By default, blocked users are included when sending invitations. The value of this option can be changed by Sendbird if your Sendbird application isn't integrated with the client app. If you want to change the value, [contact our sales team](https://get.sendbird.com/talk-to-sales.html).
    
- **Turn on or off notifications from blocked users**: Determines whether or not to receive message notifications from the blocked user in a specific 1-to-N group channel where they are both members. By default, a user doesn't receive notifications from blocked users. The value of this option can be set individually per channel. If you want to use this option, [contact our sales team](https://get.sendbird.com/talk-to-sales.html).

> **Note**: To learn more about other available moderation tools, see [Moderation Overview](https://sendbird.com/docs/chat/platform-api/v3/moderation/moderation-overview#2-actions).  The following tables explain what happens to a user's chat experience when the user blocks another user in a 1-to-1 or 1-to-N group channel. In the case of a 1-to-1 group channel, the block mode is only maintained with the original members. If other than the original members are added, the rules for 1-to-N group channel begin to apply.

[https://sendbird.com/docs/chat/platform-api/v3/moderation/blocking-users/block-users#1-block-users](https://sendbird.com/docs/chat/platform-api/v3/moderation/blocking-users/block-users#1-block-users)

## Path parameters

- `user_id` string, required

## Headers

- `api-token` string

## Request body

- BlockAUserRequest
  - `target_id` string
  - `user_ids` string[]: Specifies an array of IDs of all the users to block. This property can be used interchangeably with the users[] property when blocking multiple users at once.

## Response `200`

Successful response

- BlockAUserResponse
  - `users` SendbirdUser[]
    - `access_token` string
    - `created_at` integer
    - `discovery_keys` string[], nullable
    - `has_ever_logged_in` boolean
    - `is_active` boolean
    - `is_hide_me_from_friends` boolean
    - `is_online` boolean
    - `is_shadow_blocked` boolean
    - `last_seen_at` integer
    - `locale` string
    - `metadata` object, nullable
    - `nickname` string, nullable
    - `preferred_languages` string[], nullable
    - `profile_url` string
    - `require_auth_for_profile_image` boolean
    - `user_id` string, required
    - `state` '' | 'invited' | 'joined', nullable
    - `unread_channel_count` integer
    - `unread_message_count` integer
    - `phone_number` string
    - `is_created` boolean
  - `next` string

## Changes

- **2025-10-17** `b05d4e3c6329`: 4 breaking, 1 warning, 1 info
  - the response property `users/items/discovery_keys` became nullable for the status `200`
  - the response property `users/items/metadata` became nullable for the status `200`
  - the response property `users/items/nickname` became nullable for the status `200`
  - the response property `users/items/preferred_languages` became nullable for the status `200`
  - …2 more
- **2025-07-27** `7a85bad03e90`: 2 breaking, 3 warning, 26 info
  - the response property `users/items/` became nullable for the status `200`
  - the `users/items/` response's property type changed from `string` to `object` for status `200`
  - deleted the `header` request parameter `Api-Token`
  - removed the request property `user_id`
  - …27 more
- **2023-11-10** `135d8b0705d4`: 1 info
  - the `header` request parameter `Api-Token` became optional
- **2022-07-27** `0b6cf41bc62a`: 2 breaking
  - the `user_ids/items/` request property type changed from `integer` to `string`
  - the `users/items/` request property type changed from `integer` to `string`
- **2022-06-29** `4012275aa67d`: 2 info
  - api tag `Moderation` added
  - api tag `User` removed

[Operation history](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk/changes/v3/users/:user_id/block/post.md)

---

[API](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk.md) - [All operations](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk/llms.txt) - [OpenAPI document](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk/revisions/9e53a5288df0?raw)