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/statusAutorização
AuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
Respostas
200
The account's status
objectstringobrigatórioValores permitidos:
agent_accountstatusstringobrigatórioValores permitidos:
unclaimedclaimedclaimobject | nullobrigatórioSet while the account is unclaimed
Mostrar propriedadesOcultar propriedades
expires_atstringobrigatóriomails_leftintegerobrigatórioHow many more times the claim link can be sent again
limitsobject | nullobrigatórioSet while the account is unclaimed
Mostrar propriedadesOcultar propriedades
receive_onlybooleanobrigatórioinboxesintegerobrigatórioemails_per_dayintegerobrigatórioreceived_per_dayintegerobrigatórioEmails the account may receive per UTC day; past it the sender is told to retry
received_per_inbox_per_hourintegerobrigatórioEmails the inbox may receive per rolling hour; past it the sender is told to retry
401
Missing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório