Skip to docs content
Browse and search
On this page

confirm_action

Run a held change once the person reads back the 6-digit code emailed for it. Calling it again returns the same outcome without running the change again. Tier confirm: the call only holds the change and returns it. request_confirmation_code emails the person a code; confirm_action runs the change once they read it back. The MCP tool of the same name needs the tweetstream:billing scope.

POST/api/agent/actions/confirm_action

Authorization

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

Body

  • challengeIdstringoptionala string at most 128 character(s) long
  • codestringoptionala string matching the pattern ^\d{6}$
  • pendingActionIdstringrequireda string at most 64 character(s) long

Response fields

  • actionenum<string>required
  • outcomeobjectrequired
    • chargedCentsnumberoptional
    • effectiveAtstringrequireda string to be decoded into a Date
    • kindenum<string>required
    • refundenum<string>optional
  • pendingActionIdstringrequired
  • statusenum<string>required

Responses

  • 200Success
  • 400Invalid input, or the code is wrong (INVALID_CODE)
  • 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)
  • 429Rate limit reached (RATE_LIMITED); retry after retryAfterSeconds
  • 503Temporarily unavailable; retry later