Chilkat Online Tools

PureBasic / Twitter API v2 / Block a user ID

Back to Collection Items

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbRequestBody,"// Replace id-you-want-to-block with the ID you wish to block" + Chr(10))
    CkStringBuilder::ckAppend(sbRequestBody,"{" + Chr(10))
    CkStringBuilder::ckAppend(sbRequestBody,"    " + Chr(34) + "target_user_id" + Chr(34) + ": " + Chr(34) + "id-you-want-to-block\Chr(10))
    CkStringBuilder::ckAppend(sbRequestBody,"}")

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    resp.i = CkHttp::ckPTextSb(http,"POST","https://api.twitter.com/2/users/:id/blocking",sbRequestBody,"utf-8","application/text",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

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": [
  ]
}