Skip to docs content
Browse and search
On this page

set_delivery

Change what the stream delivers: default and per-account keyword filters and Discord webhooks, event types, affiliate alerts, Binance Square, news sources, the Instagram Discord destination, and the Truth Social, Robinhood Social and charity feeds. Tier read: the API key alone. The MCP tool of the same name needs the tweetstream:watchlist scope.

POST/api/agent/actions/set_delivery

Authorization

  • AuthorizationstringheaderrequiredBearer authentication with your TweetStream API key: Bearer <key>.

Body

  • changesobject[]requiredan array of at most 20 item(s)
    • keywordsstring[]requiredKeyword filters; an empty list delivers every post.
    • kindenum<string>required

Response fields

  • resultsobject[]required
    • kindenum<string>required
    • outcomeenum<string>required

Responses

  • 200Success
  • 400The input does not match the action's schema (INVALID_REQUEST)
  • 401Missing or invalid API key
  • 403The request carried a foreign Origin
  • 429Rate limit reached (RATE_LIMITED); retry after retryAfterSeconds
  • 503Temporarily unavailable; retry later