Verify an email code
Verify the code. Send acceptTerms true only after the person has read and agreed to https://tweetstream.io/terms. Returns the account's API key, shown once, and a setup proof that lasts 30 minutes.
POST
/api/agent/email-code/verifyBody
acceptTermsbooleanoptionalchallengeIdstringrequireda string matching the pattern ^[0-9a-f]{64}$codestringrequireda string matching the pattern ^\d{6}$familyenum<string>optional
Response fields
checkoutIdstringoptionala string matching the pattern ^pl_[a-z0-9]{1,64}$familyenum<string>requirednextobjectrequiredmessagestringoptionala string at most 500 character(s) longactionenum<string>requiredmethodenum<string>requiredurlstringrequireda string matching the pattern ^(https|wss):\/\/[^\s]+$whoenum<string>required
offerobjectoptionalamountDueNowobjectrequiredcurrencyenum<string>requiredminorstringrequireda string matching the pattern ^(0|[1-9][0-9]*)$
modeenum<string>requiredplanNamestringrequiredrenewalobjectrequiredamountobjectrequiredcurrencyenum<string>requiredminorstringrequireda string matching the pattern ^(0|[1-9][0-9]*)$
atstringrequireda string to be decoded into a DatebillingCycleenum<string>requiredthenAmountobjectrequiredcurrencyenum<string>requiredminorstringrequireda string matching the pattern ^(0|[1-9][0-9]*)$
paymentUrlstringoptionala string matching the pattern ^(https|wss):\/\/[^\s]+$reasonenum<string>requiredstatusenum<string>requiredapiKeystringrequiredsetupProofstringrequired
Responses
- 200Success
- 400Invalid request, wrong code, or the Terms were not accepted
- 403The account is restricted, or the request carried a foreign Origin
- 429Rate limit or activation budget reached; retry after retryAfterSeconds
- 503Temporarily unavailable; retry later