Chilkat Online Tools

Ruby / Twitter API v2 / Block a user ID

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

sbRequestBody = Chilkat::CkStringBuilder.new()
sbRequestBody.Append("// Replace id-you-want-to-block with the ID you wish to block\n")
sbRequestBody.Append("{\n")
sbRequestBody.Append("    \"target_user_id\": \"id-you-want-to-block\"\n")
sbRequestBody.Append("}")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

# resp is a CkHttpResponse
resp = http.PTextSb("POST","https://api.twitter.com/2/users/:id/blocking",sbRequestBody,"utf-8","application/text",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '// Replace id-you-want-to-block with the ID you wish to block
{
    "target_user_id": "id-you-want-to-block"
}'
https://api.twitter.com/2/users/:id/blocking

Postman Collection Item JSON

{
  "name": "Block a user ID",
  "request": {
    "auth": {
      "type": "oauth1",
      "oauth1": [
        {
          "key": "consumerKey",
          "value": "",
          "type": "string"
        },
        {
          "key": "tokenSecret",
          "value": "",
          "type": "string"
        },
        {
          "key": "token",
          "value": "",
          "type": "string"
        },
        {
          "key": "consumerSecret",
          "value": "",
          "type": "string"
        },
        {
          "key": "addParamsToHeader",
          "value": true,
          "type": "boolean"
        },
        {
          "key": "signatureMethod",
          "value": "HMAC-SHA1",
          "type": "string"
        },
        {
          "key": "version",
          "value": "1.0",
          "type": "string"
        },
        {
          "key": "addEmptyParamsToSign",
          "value": false,
          "type": "boolean"
        }
      ]
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "// Replace id-you-want-to-block with the ID you wish to block\n{\n    \"target_user_id\": \"id-you-want-to-block\"\n}"
    },
    "url": {
      "raw": "https://api.twitter.com/2/users/:id/blocking",
      "protocol": "https",
      "host": [
        "api",
        "twitter",
        "com"
      ],
      "path": [
        "2",
        "users",
        ":id",
        "blocking"
      ],
      "variable": [
        {
          "key": "id",
          "value": ""
        }
      ]
    },
    "description": "Allows a user ID to block another user.\n\nFor full details, see the [API reference](https://developer.twitter.com/en/docs/twitter-api/users/blocks/api-reference/post-users-user_id-blocking) for this endpoint.\n\n[Sign up](https://t.co/signup) for the Twitter API"
  },
  "response": [
  ]
}