---
search:
  tags:
    - Agent
    - POST
seo:
  description: >-
    BillionSend extension, no API key needed. Creates an account for an agent
    without a… Reference for the POST /agent/signup endpoint in the BillionSend
    API.
sidebar:
  label: Sign up as an agent
  badge: POST
title: Sign up as an agent
type: openapi-operation
---
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** (`application/json`, required)

- `human_email` (string, required) — 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.
- `name` (string, required) — 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.
- `username` (string) — 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.

Request body example:

```json
{
  "human_email": "string",
  "name": "string",
  "username": "string"
}
```

**Responses**

- `201` — The unclaimed account, its inbox and its key
- `409` — The username is already used by an inbox
- `422` — Validation error: human\_email, name or username refused (disposable or BillionSend address, not a plain name, a brand look-alike, a reserved name)
- `429` — Too many signups from this address, in all, or for this human\_email; retry-after says when to try again
- `503` — The username can't be reviewed right now; retry-after says when to try again

Response example, 201:

```json
{
  "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
  }
}
```
