Skip to docs content
Browse and search
On this page

Add monitored accounts

Add one or more monitored X/Twitter accounts.

POST/api/add-account

Authorization

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

Body

  • accountsstring | string[]required

Response fields

  • actionenum<string>required
  • errorstring | nullrequired
  • requestIdstringrequired
  • resultsobject[]required
    • inputstringrequired
    • messagestringoptional
    • stateenum<string>required
  • summaryobjectrequired
    • failedintegerrequired
    • succeededintegerrequired
    • totalintegerrequired

Responses

  • 200Success
  • 207Some requested account operations succeeded and some failed
  • 400Invalid request
  • 401Missing or invalid API key
  • 403The authenticated account cannot use this capability
  • 429Too many handle requests
  • 500The request could not be completed
  • 503Account management is temporarily unavailable