Skip to content
Esc
↑↓navigate↵open⌘Jpreview

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
Request body
requiredapplication/json
human_emailstringrequired

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.

min length 3 · max length 254
namestringrequired

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.

min length 1 · max length 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.

max length 64
Responses
201

The unclaimed account, its inbox and its key

objectstringrequired
Allowed:agent_signup
statusstringrequired
Allowed:unclaimed
api_keystringrequired

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

inboxInboxrequired
Show properties
objectstringrequired
Allowed:inbox
idstring<uuid>required
namestringrequired
email_addressstringrequired
domain_idstring<uuid>required

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

receiving_addressstring | nullrequired
from_namestring | nullrequired
unreadintegerrequired

Threads with an unread message

draftsintegerrequired

Unsent drafts

last_receivedstring | nullrequired
created_atstringrequired
updated_atstringrequired
kindstringrequired
Allowed:agenthuman
sharedbooleanrequired

On the shared inbox domain

expires_atstring | nullrequired
quarantinedintegerrequired

Held messages not yet released

pending_approvalintegerrequired

Drafts waiting for a person

claimobjectrequired
Show properties
emailstringrequired

Where the claim link was sent

expires_atstringrequired

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

limitsobjectrequired

What the account may do while nobody has claimed it

Show properties
receive_onlybooleanrequired
inboxesintegerrequired
emails_per_dayintegerrequired
received_per_dayintegerrequired

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

received_per_inbox_per_hourintegerrequired

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

statusCodenumberrequired
namestringrequired
messagestringrequired
422

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

statusCodenumberrequired
namestringrequired
messagestringrequired
429

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

statusCodenumberrequired
namestringrequired
messagestringrequired
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

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Bodyapplication/json
Request
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"
}'
Response
{
  "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
  }
}

Was this page helpful?