Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

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/status
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Respuestas
200

The account's status

objectstringobligatorio
Valores permitidos:agent_account
statusstringobligatorio
Valores permitidos:unclaimedclaimed
claimobject | nullobligatorio

Set while the account is unclaimed

Mostrar propiedades
expires_atstringobligatorio
mails_leftintegerobligatorio

How many more times the claim link can be sent again

limitsobject | nullobligatorio

Set while the account is unclaimed

Mostrar propiedades
receive_onlybooleanobligatorio
inboxesintegerobligatorio
emails_per_dayintegerobligatorio
received_per_dayintegerobligatorio

Emails the account may receive per UTC day; past it the sender is told to retry

received_per_inbox_per_hourintegerobligatorio

Emails the inbox may receive per rolling hour; past it the sender is told to retry

401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Solicitud
curl -X GET 'https://api.billionsend.com/agent/status' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Respuesta
{
  "object": "agent_account",
  "status": "unclaimed",
  "claim": {
    "expires_at": "string",
    "mails_left": 0
  },
  "limits": {
    "receive_only": true,
    "inboxes": 0,
    "emails_per_day": 0,
    "received_per_day": 0,
    "received_per_inbox_per_hour": 0
  }
}

¿Te ha resultado útil esta página?