POST
/
2
/
tweets
/
search
/
stream
/
rules
Update stream rules
curl --request POST \
  --url https://api.x.com/2/tweets/search/stream/rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "add": [
    {
      "tag": "Non-retweeted coffee Posts",
      "value": "coffee -is:retweet"
    }
  ]
}'
{
  "data": [
    {
      "id": "120897978112909812",
      "tag": "Non-retweeted coffee Posts",
      "value": "coffee -is:retweet"
    }
  ],
  "errors": [
    {
      "detail": "<string>",
      "status": 123,
      "title": "<string>",
      "type": "<string>"
    }
  ],
  "meta": {
    "next_token": "<string>",
    "result_count": 123,
    "sent": "<string>",
    "summary": {
      "created": 1,
      "invalid": 1,
      "not_created": 1,
      "valid": 1
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
dry_run
boolean

Dry Run can be used with both the add and delete action, with the expected result given, but without actually taking any action in the system (meaning the end state will always be as it was when the request was submitted). This is particularly useful to validate rule changes.

​
delete_all
boolean

Delete All can be used to delete all of the rules associated this client app, it should be specified with no other parameters. Once deleted, rules cannot be recovered.

Body

application/json

A request to add a user-specified stream filtering rule.

Response

200
application/json

The request has succeeded.

A response from modifying user-specified stream filtering rules.