Skip to main content
POST
/
inboxes
cURL
curl -X POST 'https://api.nuntly.com/inboxes' \
  -H 'Authorization: Bearer apk_xxx' \
  -H 'Content-Type: application/json' \
  -d '{"address":"<address>"}'
{
  "data": {
    "id": "<string>",
    "createdAt": "<string>",
    "domainId": "<string>",
    "domainName": "<string>",
    "address": "<string>",
    "name": "<string>",
    "namespaceId": "<string>",
    "namespaceName": "<string>",
    "agentId": "<string>",
    "updatedAt": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Use an API key from https://nuntly.com/dashboard/api-keys. Required on every endpoint.

Body

application/json
​
address
string
required

The local-part of the email address (before the @).

​
domainId
string

The id of the domain for this inbox. Defaults to your provided domain when omitted.

​
name
string

The display name of the inbox.

​
namespaceId
string

The id of the namespace to assign the inbox to.

​
agentId
string

The external AI agent identifier.

Response

Created.

​
data
object
required