Skip to main content

​
Create Email Address

curl -X POST https://inbound.new/api/e2/email-addresses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "address": "[email protected]",
    "domainId": "dom_abc123",
    "endpointId": "ep_xyz789",
    "isActive": true
  }'

​
POST /api/e2/email-addresses

Create a new email address for an authenticated user’s domain, optionally routing to a webhook or endpoint.

​
Request Parameters

​
address
string
required
Complete email address (e.g., [email protected]).Must match valid email format and belong to the specified domain.
​
domainId
string
required
ID of the verified domain this email address belongs to.
​
endpointId
string
ID of the endpoint to route emails to. Mutually exclusive with webhookId.
​
webhookId
string
ID of the webhook to route emails to. Mutually exclusive with endpointId.
​
isActive
boolean
default:"true"
Whether the email address is active and should receive emails.

​
Response

​
id
string
Unique identifier for the email address.
​
address
string
The email address.
​
domainId
string
ID of the parent domain.
​
webhookId
string
ID of the configured webhook (if any).
​
endpointId
string
ID of the configured endpoint (if any).
​
isActive
boolean
Whether the email address is active.
​
isReceiptRuleConfigured
boolean
Whether AWS SES receipt rule is configured for this address.
​
receiptRuleName
string
Name of the AWS SES receipt rule.
​
createdAt
string
ISO 8601 timestamp when the email address was created.
​
updatedAt
string
ISO 8601 timestamp when the email address was last updated.
​
userId
string
ID of the user who owns this email address.
​
domain
object
Domain reference object.
​
routing
object
Routing configuration.
​
warning
string
Warning message if AWS configuration is incomplete.
{
  "id": "addr_abc123",
  "address": "[email protected]",
  "domainId": "dom_abc123",
  "webhookId": null,
  "endpointId": "ep_xyz789",
  "isActive": true,
  "isReceiptRuleConfigured": true,
  "receiptRuleName": "batch-rule-001",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "userId": "usr_abc123",
  "domain": {
    "id": "dom_abc123",
    "name": "example.com",
    "status": "verified"
  },
  "routing": {
    "type": "endpoint",
    "id": "ep_xyz789",
    "name": "Support Webhook",
    "config": {
      "url": "https://api.example.com/webhooks/email"
    },
    "isActive": true
  }
}

​
List Email Addresses

curl -X GET "https://inbound.new/api/e2/email-addresses?domainId=dom_abc123&limit=50" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
GET /api/e2/email-addresses

Get paginated list of email addresses for authenticated user with optional filtering by domain, active status, and receipt rule configuration.

​
Query Parameters

​
limit
integer
default:"50"
Maximum number of email addresses to return (1-100).
​
offset
integer
default:"0"
Number of email addresses to skip for pagination.
​
domainId
string
Filter by domain ID.
​
isActive
string
Filter by active status: true or false.
​
isReceiptRuleConfigured
string
Filter by receipt rule configuration: true or false.

​
Response

​
data
array
Array of email address objects (same structure as Create Email Address response).
​
pagination
object
Pagination metadata.
{
  "data": [
    {
      "id": "addr_abc123",
      "address": "[email protected]",
      "domainId": "dom_abc123",
      "webhookId": null,
      "endpointId": "ep_xyz789",
      "isActive": true,
      "isReceiptRuleConfigured": true,
      "receiptRuleName": "batch-rule-001",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z",
      "userId": "usr_abc123",
      "domain": {
        "id": "dom_abc123",
        "name": "example.com",
        "status": "verified"
      },
      "routing": {
        "type": "endpoint",
        "id": "ep_xyz789",
        "name": "Support Webhook",
        "config": {
          "url": "https://api.example.com/webhooks/email"
        },
        "isActive": true
      }
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 1,
    "hasMore": false
  }
}

​
Get Email Address

curl -X GET https://inbound.new/api/e2/email-addresses/addr_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

​
GET /api/e2/email-addresses/:id

Get a specific email address by ID with detailed information including routing configuration.

​
Response

Same structure as Create Email Address response. 
{
  "id": "addr_abc123",
  "address": "[email protected]",
  "domainId": "dom_abc123",
  "webhookId": null,
  "endpointId": "ep_xyz789",
  "isActive": true,
  "isReceiptRuleConfigured": true,
  "receiptRuleName": "batch-rule-001",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "userId": "usr_abc123",
  "domain": {
    "id": "dom_abc123",
    "name": "example.com",
    "status": "verified"
  },
  "routing": {
    "type": "endpoint",
    "id": "ep_xyz789",
    "name": "Support Webhook",
    "config": {
      "url": "https://api.example.com/webhooks/email"
    },
    "isActive": true
  }
}

​
Update Email Address

curl -X PATCH https://inbound.new/api/e2/email-addresses/addr_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "endpointId": "ep_new789",
    "isActive": true
  }'

​
PATCH /api/e2/email-addresses/:id

Update an email address’s routing configuration and active status.

​
Request Parameters

​
endpointId
string
ID of the endpoint to route emails to. Set to null to remove endpoint routing.
​
webhookId
string
ID of the webhook to route emails to. Set to null to remove webhook routing.
​
isActive
boolean
Whether the email address should be active and receive emails.

​
Response

Same structure as Create Email Address response. 
{
  "id": "addr_abc123",
  "address": "[email protected]",
  "domainId": "dom_abc123",
  "webhookId": null,
  "endpointId": "ep_new789",
  "isActive": true,
  "isReceiptRuleConfigured": true,
  "receiptRuleName": "batch-rule-001",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:35:00Z",
  "userId": "usr_abc123",
  "domain": {
    "id": "dom_abc123",
    "name": "example.com",
    "status": "verified"
  },
  "routing": {
    "type": "endpoint",
    "id": "ep_new789",
    "name": "New Support Webhook",
    "config": {
      "url": "https://api.example.com/webhooks/new-email"
    },
    "isActive": true
  }
}

​
Delete Email Address

curl -X DELETE https://inbound.new/api/e2/email-addresses/addr_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

​
DELETE /api/e2/email-addresses/:id

Delete an email address. The address will no longer receive emails.

​
Response

​
success
boolean
Whether the deletion was successful.
​
message
string
Human-readable message about the deletion result.
​
id
string
ID of the deleted email address.
{
  "success": true,
  "message": "Email address deleted successfully",
  "id": "addr_abc123"
}

​
Validation Rules

​
Email Address Format

  • Must be a valid email format: [email protected]
  • Domain must match the specified domainId
  • Must be unique across the platform

​
Routing Configuration

  • Only one routing method can be active: either endpointId OR webhookId
  • The specified endpoint or webhook must:
    • Belong to the same user
    • Be active
    • Exist in the system

​
Domain Requirements

  • Parent domain must be:
    • Owned by the user
    • In verified status
    • Have DNS records properly configured

Build docs developers (and LLMs) love

Get started for freeTalk to us