Get the account's claim status
BillionSend extension. Whether the account behind the key is still unclaimed, when it deletes itself, and what it may do meanwhile. Any key may ask; an account a person has claimed answers claimed with no limits.
GET
/agent/statusAutorisierung
AuthorizationBearer-Token · headererforderlichA BillionSend API key (bs_…).
Antworten
200
The account's status
objectstringerforderlichErlaubt:
agent_accountstatusstringerforderlichErlaubt:
unclaimedclaimedclaimobject | nullerforderlichSet while the account is unclaimed
Eigenschaften anzeigenEigenschaften ausblenden
expires_atstringerforderlichmails_leftintegererforderlichHow many more times the claim link can be sent again
limitsobject | nullerforderlichSet while the account is unclaimed
Eigenschaften anzeigenEigenschaften ausblenden
receive_onlybooleanerforderlichinboxesintegererforderlichemails_per_dayintegererforderlichreceived_per_dayintegererforderlichEmails the account may receive per UTC day; past it the sender is told to retry
received_per_inbox_per_hourintegererforderlichEmails the inbox may receive per rolling hour; past it the sender is told to retry
401
Missing, malformed, unknown or revoked API key
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich