Pular para o conteúdo
Esc
↑↓navegar↵abrir⌘Jpré-visualizar

Sign up as an agent

BillionSend extension, no API key needed. Creates an account for an agent without a person present: a team named after the agent, one inbox on the shared domain (no DNS) and an inbox-scoped key for it, so the agent can receive mail at once. The account is unclaimed: it only receives, and every send answers 403 team_unclaimed. A claim link goes to human_email; the person opens it, signs in and claims the account, which becomes theirs on the Free plan (the key keeps working, as an inbox-scoped key under their team). An account nobody claims deletes itself 7 days after signup. Limits: 3 signups per client address per hour, 100 per hour in all, 3 per human_email per day.

POST/agent/signup
Corpo da requisição
obrigatórioapplication/json
human_emailstringobrigatório

The person behind the agent. The claim link goes to this address and nowhere else. A disposable-email address, or one on a BillionSend domain, answers 422; at most 3 unclaimed accounts wait on one address.

comprimento mín. 3 · comprimento máx. 254
namestringobrigatório

The agent's name, at most 60 characters, a plain name (no @, links or phone numbers). It becomes the account's name until a person renames it. A brand look-alike answers 422.

comprimento mín. 1 · comprimento máx. 120
usernamestring

The part before the @ of the inbox address, under the same rules as POST /inboxes (reserved names and brand look-alikes answer 422, a name in use 409). Omitted: a random one.

comprimento máx. 64
Respostas
201

The unclaimed account, its inbox and its key

objectstringobrigatório
Valores permitidos:agent_signup
statusstringobrigatório
Valores permitidos:unclaimed
api_keystringobrigatório

An inbox-scoped key for the inbox below. Shown once; store it now.

inboxInboxobrigatório
Mostrar propriedades
objectstringobrigatório
Valores permitidos:inbox
idstring<uuid>obrigatório
namestringobrigatório
email_addressstringobrigatório
domain_idstring<uuid>obrigatório

A shared address's is its team's shared subdomain: the GET /domains row with shared: true

receiving_addressstring | nullobrigatório
from_namestring | nullobrigatório
unreadintegerobrigatório

Threads with an unread message

draftsintegerobrigatório

Unsent drafts

last_receivedstring | nullobrigatório
created_atstringobrigatório
updated_atstringobrigatório
kindstringobrigatório
Valores permitidos:agenthuman
sharedbooleanobrigatório

On the shared inbox domain

expires_atstring | nullobrigatório
quarantinedintegerobrigatório

Held messages not yet released

pending_approvalintegerobrigatório

Drafts waiting for a person

claimobjectobrigatório
Mostrar propriedades
emailstringobrigatório

Where the claim link was sent

expires_atstringobrigatório

When the account deletes itself if nobody claimed it, as ISO 8601

limitsobjectobrigatório

What the account may do while nobody has claimed it

Mostrar propriedades
receive_onlybooleanobrigatório
inboxesintegerobrigatório
emails_per_dayintegerobrigatório
received_per_dayintegerobrigatório

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

received_per_inbox_per_hourintegerobrigatório

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

409

The username is already used by an inbox

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
422

Validation error: human_email, name or username refused (disposable or BillionSend address, not a plain name, a brand look-alike, a reserved name)

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

Too many signups from this address, in all, or for this human_email; retry-after says when to try again

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
503

This instance does not offer agent signup, or the username can't be reviewed right now; retry-after says when to try again where it applies

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Corpoapplication/json
Requisição
curl -X POST 'https://api.billionsend.com/agent/signup' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "human_email": "string",
  "name": "string",
  "username": "string"
}'
Resposta
{
  "object": "agent_signup",
  "status": "unclaimed",
  "api_key": "string",
  "inbox": {
    "object": "inbox",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "email_address": "string",
    "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",
    "receiving_address": "string",
    "from_name": "string",
    "unread": 0,
    "drafts": 0,
    "last_received": "string",
    "created_at": "string",
    "updated_at": "string",
    "kind": "agent",
    "shared": true,
    "expires_at": "string",
    "quarantined": 0,
    "pending_approval": 0
  },
  "claim": {
    "email": "string",
    "expires_at": "string"
  },
  "limits": {
    "receive_only": true,
    "inboxes": 0,
    "emails_per_day": 0,
    "received_per_day": 0,
    "received_per_inbox_per_hour": 0
  }
}

Esta página foi útil?