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/statusAutorisation
AuthorizationJeton Bearer · headerrequisA BillionSend API key (bs_…).
Réponses
200
The account's status
objectstringrequisValeurs autorisées :
agent_accountstatusstringrequisValeurs autorisées :
unclaimedclaimedclaimobject | nullrequisSet while the account is unclaimed
Afficher les propriétésMasquer les propriétés
expires_atstringrequismails_leftintegerrequisHow many more times the claim link can be sent again
limitsobject | nullrequisSet while the account is unclaimed
Afficher les propriétésMasquer les propriétés
receive_onlybooleanrequisinboxesintegerrequisemails_per_dayintegerrequisreceived_per_dayintegerrequisEmails the account may receive per UTC day; past it the sender is told to retry
received_per_inbox_per_hourintegerrequisEmails the inbox may receive per rolling hour; past it the sender is told to retry
401
Missing, malformed, unknown or revoked API key
statusCodenumberrequisnamestringrequismessagestringrequis429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequisnamestringrequismessagestringrequis