POST /2/users/:id/blocking

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

tweet.read

users.read

block.write

Learn more about OAuth 2.0 Authorization Code with PKCE

Path parameters

NameTypeDescription
id
 Required 
stringThe 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

NameTypeDescription
target_user_id
 Required 
stringThe 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

TypeScript
Java
      (async () => {
  try {
    const blockUser = await twitterClient.users.usersIdBlock(
      //The ID of the user that is requesting to block the target user
      "6253282",
      {
        //The ID of the user that the source user is requesting to block
        target_user_id: "2244994945",
      }
    );
    console.dir(blockUser, {
      depth: null,
    });
  } catch (error) {
    console.log(error);
  }
})();

    
      // Set the params values

UsersIdBlockRequest usersIdBlockRequest = new UsersIdBlockRequest(); 
//The ID of the user that the source user is requesting to block
usersIdBlockRequest.targetUserId("2244994945");

// String | The ID of the user that is requesting to block the target user
String id = "6253282";
try {
    UsersBlockingMutationResponse result = apiInstance.users().usersIdBlock(usersIdBlockRequest, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#usersIdBlock");
    System.err.println("Status code: " + e.getCode());
    System.err.println("Reason: " + e.getResponseBody());
    System.err.println("Response headers: " + e.getResponseHeaders());
    e.printStackTrace();
}

    

Example responses

Successful response
      {
  "data": {
    "blocking": true
  }
}
    

Response fields

NameTypeDescription
blockingbooleanIndicates whether the user is blocking the specified user as a result of this request.