Skip to main content
POST
/
inboxes
JavaScript
import Nuntly from '@nuntly/sdk';

const client = new Nuntly({
  apiKey: process.env['NUNTLY_API_KEY'], // This is the default and can be omitted
});

const inbox = await client.inboxes.create({ address: 'x' });

console.log(inbox.id);
{
  "data": {
    "id": "<string>",
    "createdAt": "<string>",
    "domainId": "<string>",
    "domainName": "<string>",
    "address": "<string>",
    "name": "<string>",
    "namespaceId": "<string>",
    "namespaceName": "<string>",
    "status": "active",
    "agentId": "<string>",
    "updatedAt": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer HTTP authentication. Allowed headers Authorization: Bearer <API_KEY>

Body

application/json

Inbox address, domain, and optional namespace or agent assignment.

​
address
string
required

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

Minimum string length: 1
​
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

Successful response.

​
data
object
required