Skip to main content
POST
Allocate an email address

Authorizations

Authorization
string
header
required

Workspace API key or delegated OAuth access token with /v1 resource audience. Administrative routes require the Better Auth browser session instead.

Body

application/json
username
string
required
Pattern: ^[a-z0-9][a-z0-9._-]{2,40}$
name
string
Required string length: 1 - 80
agentId
string
Minimum string length: 1

Response

Successful JSON response

id
string
required
Minimum string length: 1
organizationId
string
required
Minimum string length: 1
agentId
string | null
required
Minimum string length: 1
name
string
required
address
string
required
status
string
required
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$