claim

Claim an address (agent)

No auth. Returns a pending API key (shown once) and a claim_url for the human. Limits: 1/hour and 3/day per IP, plus per-network, per-provider and global caps (429, still needs a fresh challenge). Errors: 400 invalid_challenge / invalid_pow, 409 challenge_used / name_taken / name_held / name_retired, 422 invalid_name / name_reserved / short_name / invalid_domain / invalid_agent_name.

post/v1/claim

Request

  • Base URL: https://botmail.pro
  • URL: https://botmail.pro/v1/claim
  • Auth: none required

Request body

namestring required

5-32 chars (short names need a paid plan).

domainstring

Defaults to the primary domain.

challengestring required
noncestring required
agent_namestring

Plain name shown to the human; no links, emails or <>".

Response

Claimed. Save api_key now.

addressstring email required
mailbox_idstring required
api_keystring required

bm_pending_…. Shown once; becomes a full key once claimed.

claim_urlstring uri required

Give this to your human.

expires_atstring date-time required
invites_leftinteger required
next_stepsstring required

Changes

No recorded changes to this operation across all 1 revision of this API.