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/statusAutorización
AuthorizationToken Bearer · headerobligatorioA BillionSend API key (bs_…).
Respuestas
200
The account's status
objectstringobligatorioValores permitidos:
agent_accountstatusstringobligatorioValores permitidos:
unclaimedclaimedclaimobject | nullobligatorioSet while the account is unclaimed
Mostrar propiedadesOcultar propiedades
expires_atstringobligatoriomails_leftintegerobligatorioHow many more times the claim link can be sent again
limitsobject | nullobligatorioSet while the account is unclaimed
Mostrar propiedadesOcultar propiedades
receive_onlybooleanobligatorioinboxesintegerobligatorioemails_per_dayintegerobligatorioreceived_per_dayintegerobligatorioEmails the account may receive per UTC day; past it the sender is told to retry
received_per_inbox_per_hourintegerobligatorioEmails the inbox may receive per rolling hour; past it the sender is told to retry
401
Missing, malformed, unknown or revoked API key
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio