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.
/agent/signupapplication/jsonhuman_emailstring必填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.
namestring必填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.
usernamestringThe 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.
The unclaimed account, its inbox and its key
objectstring必填agent_signupstatusstring必填unclaimedapi_keystring必填An inbox-scoped key for the inbox below. Shown once; store it now.
inboxInbox必填显示属性隐藏属性
objectstring必填inboxidstring<uuid>必填namestring必填email_addressstring必填domain_idstring<uuid>必填A shared address's is its team's shared subdomain: the GET /domains row with shared: true
receiving_addressstring | null必填from_namestring | null必填unreadinteger必填Threads with an unread message
draftsinteger必填Unsent drafts
last_receivedstring | null必填created_atstring必填updated_atstring必填kindstring必填agenthumansharedboolean必填On the shared inbox domain
expires_atstring | null必填quarantinedinteger必填Held messages not yet released
pending_approvalinteger必填Drafts waiting for a person
claimobject必填显示属性隐藏属性
emailstring必填Where the claim link was sent
expires_atstring必填When the account deletes itself if nobody claimed it, as ISO 8601
limitsobject必填What the account may do while nobody has claimed it
显示属性隐藏属性
receive_onlyboolean必填inboxesinteger必填emails_per_dayinteger必填received_per_dayinteger必填Emails the account may receive per UTC day; past it the sender is told to retry
received_per_inbox_per_hourinteger必填Emails the inbox may receive per rolling hour; past it the sender is told to retry
The username is already used by an inbox
statusCodenumber必填namestring必填messagestring必填Validation error: human_email, name or username refused (disposable or BillionSend address, not a plain name, a brand look-alike, a reserved name)
statusCodenumber必填namestring必填messagestring必填Too many signups from this address, in all, or for this human_email; retry-after says when to try again
statusCodenumber必填namestring必填messagestring必填The username can't be reviewed right now; retry-after says when to try again
statusCodenumber必填namestring必填messagestring必填