POST /2/users/:id/blocking
Causes the user (in the path) to block the target user. The user (in the path) must match the user Access Tokens being used to authorize the request.
Endpoint URL
https://api.twitter.com/2/users/:id/blocking
Authentication and rate limits
Authentication methods supported by this endpoint | OAuth 2.0 Authorization Code with PKCE OAuth 1.0a is also available for this endpoint. |
---|---|
Rate limit | User rate limit (User context): 50 requests per 15-minute window per each authenticated user |
OAuth 2.0 scopes required by this endpoint
|
Learn more about OAuth 2.0 Authorization Code with PKCE |
Path parameters
Name | Type | Description |
---|---|---|
id Required | string | The user ID who you would like to initiate the block on behalf of. It must match your own user ID or that of an authenticating user, meaning that you must pass the Access Tokens associated with the user ID when authenticating your request. |
JSON body parameters
Name | Type | Description |
---|---|---|
target_user_id Required | string | The user ID of the user that you would like the id to block. The body should contain a string of the user ID inside of a JSON object. |
Example code with offical SDKs
Example responses
Response fields
Name | Type | Description |
---|---|---|
blocking | boolean | Indicates whether the user is blocking the specified user as a result of this request. |