Addresses

Mint a new alias.

Requires manage scope. type picks the shape: standard (default, adjective-noun-NN), agent (agent-xxxxxxxx, flagged kind: agent) or domain (yourdomain.com-xxxxxxxx, flagged kind: agent, needs domain_id or domain naming one of your verified domains — invalid_domain, 400 otherwise). Standard aliases are gated by the open-address count cap (cap_reached, 403, body carries used/limit) and the Early-Adopter rotation cooldown (rotation_cooldown, 429, body carries retry_after_sec/next_allowed_at). agent and domain aliases share a separate agent allowance (cap_reached, 403, pool: "agent") and skip the cooldown.

post/v1/addresses

Request

  • Base URL: https://api.inboxy.net
  • URL: https://api.inboxy.net/v1/addresses
  • Auth: HTTP bearer

Request body

labelstring

Optional user-facing label.

scheme'adjective-noun' | 'opaque'

Generation scheme for standard aliases. adjective-noun → e.g. brisk-otter-42; opaque → random.

type'standard' | 'agent' | 'domain'

agent → agent-xxxxxxxx; domain → yourdomain.com-xxxxxxxx (requires domain_id). Both are flagged kind: agent.

domain_idstring uuid

A verified domain's id (from GET /v1/domains). Required (or domain) when type is domain.

domainstring

Alternative to domain_id: the verified domain's hostname, e.g. nike.com.

Response

Created.

idstring uuid required
local_partstring required
full_addressstring email required
labelstring nullable
status'active' | 'retired' required
kind'standard' | 'agent'

agent aliases draw from the separate agent allowance.

created_atinteger required
retired_atinteger nullable
totalinteger

Total messages ever received at this alias (list-view only).

unreadinteger

Unread messages currently on this alias (list-view only).

Changes

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