Skip to docs content
Browse and search
On this page

request_confirmation_code

Email the person a 6-digit code for one held change, naming the change, its price and its date. The code expires with the held change; asking again replaces the earlier code. Tier read: the API key alone. The MCP tool of the same name needs the tweetstream:billing scope.

POST/api/agent/actions/request_confirmation_code

Authorization

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

Body

  • pendingActionIdstringrequireda string at most 64 character(s) long

Response fields

  • challengeIdstringrequired
  • expiresAtstringrequireda string to be decoded into a Date
  • nextobjectrequired
    • actionenum<string>required
    • messagestringrequired
    • namestringrequired
    • whoenum<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
  • 404No held change with that pendingActionId for this API key (CONFIRMATION_NOT_FOUND)
  • 409The held change expired (CONFIRMATION_EXPIRED) or is already confirmed (ACTION_REFUSED)
  • 429Rate limit reached (RATE_LIMITED); retry after retryAfterSeconds
  • 503Temporarily unavailable; retry later