Create mailbox
curl --request POST \
--url https://console.mermail.app/api/v1/mailboxes \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"email": "[email protected]",
"name": "Acme Ops",
"workspaceId": "ws_01abc"
}
'import requests
url = "https://console.mermail.app/api/v1/mailboxes"
payload = {
"email": "[email protected]",
"name": "Acme Ops",
"workspaceId": "ws_01abc"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: '[email protected]', name: 'Acme Ops', workspaceId: 'ws_01abc'})
};
fetch('https://console.mermail.app/api/v1/mailboxes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://console.mermail.app/api/v1/mailboxes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '[email protected]',
'name' => 'Acme Ops',
'workspaceId' => 'ws_01abc'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://console.mermail.app/api/v1/mailboxes"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"name\": \"Acme Ops\",\n \"workspaceId\": \"ws_01abc\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://console.mermail.app/api/v1/mailboxes")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"[email protected]\",\n \"name\": \"Acme Ops\",\n \"workspaceId\": \"ws_01abc\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.mermail.app/api/v1/mailboxes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"[email protected]\",\n \"name\": \"Acme Ops\",\n \"workspaceId\": \"ws_01abc\"\n}"
response = http.request(request)
puts response.read_body{
"id": "[email protected]",
"public_id": "aaaaaaaa-bbbb-4ccc-8ddd-eeeeeeeeeeee",
"workspace_id": "ws_01abc",
"email": "[email protected]",
"name": "Acme Ops",
"email_domain_id": "ed_01xyz",
"inbound_provider": "cloudflare_routing",
"outbound_provider": "cloudflare_email",
"provider_metadata": {
"domain": "mail.acme.com",
"provider": "resend"
},
"bucket_id": "bkt_01xyz",
"settings": {
"forwarding": {
"enabled": false,
"email": ""
},
"signature": {
"enabled": false,
"text": ""
},
"autoReply": {
"enabled": false,
"subject": "",
"message": ""
},
"agentAutoResponse": {
"requireApproval": true
},
"fromName": "Acme Support"
},
"welcome_onboarding_status": "pending"
}{
"error": "workspaceId is required"
}{
"error": "Unauthorized"
}{
"error": "Invalid request"
}{
"error": "Forbidden"
}{
"error": "Too many requests"
}Mailboxes
Create mailbox
Plans: Free · Developer · Enterprise
Provisions a mailbox. workspaceId is required in the body for this route (or is supplied by the API key’s bound workspace). Requires workspace admin. Returns 201. Costs provision credits (10).
API credits: 10 (provision).
POST
https://console.mermail.app
/
api
/
v1
/
mailboxes
Create mailbox
curl --request POST \
--url https://console.mermail.app/api/v1/mailboxes \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"email": "[email protected]",
"name": "Acme Ops",
"workspaceId": "ws_01abc"
}
'import requests
url = "https://console.mermail.app/api/v1/mailboxes"
payload = {
"email": "[email protected]",
"name": "Acme Ops",
"workspaceId": "ws_01abc"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: '[email protected]', name: 'Acme Ops', workspaceId: 'ws_01abc'})
};
fetch('https://console.mermail.app/api/v1/mailboxes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://console.mermail.app/api/v1/mailboxes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '[email protected]',
'name' => 'Acme Ops',
'workspaceId' => 'ws_01abc'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://console.mermail.app/api/v1/mailboxes"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"name\": \"Acme Ops\",\n \"workspaceId\": \"ws_01abc\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://console.mermail.app/api/v1/mailboxes")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"[email protected]\",\n \"name\": \"Acme Ops\",\n \"workspaceId\": \"ws_01abc\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.mermail.app/api/v1/mailboxes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"[email protected]\",\n \"name\": \"Acme Ops\",\n \"workspaceId\": \"ws_01abc\"\n}"
response = http.request(request)
puts response.read_body{
"id": "[email protected]",
"public_id": "aaaaaaaa-bbbb-4ccc-8ddd-eeeeeeeeeeee",
"workspace_id": "ws_01abc",
"email": "[email protected]",
"name": "Acme Ops",
"email_domain_id": "ed_01xyz",
"inbound_provider": "cloudflare_routing",
"outbound_provider": "cloudflare_email",
"provider_metadata": {
"domain": "mail.acme.com",
"provider": "resend"
},
"bucket_id": "bkt_01xyz",
"settings": {
"forwarding": {
"enabled": false,
"email": ""
},
"signature": {
"enabled": false,
"text": ""
},
"autoReply": {
"enabled": false,
"subject": "",
"message": ""
},
"agentAutoResponse": {
"requireApproval": true
},
"fromName": "Acme Support"
},
"welcome_onboarding_status": "pending"
}{
"error": "workspaceId is required"
}{
"error": "Unauthorized"
}{
"error": "Invalid request"
}{
"error": "Forbidden"
}{
"error": "Too many requests"
}Authorizations
API key (sk-proj-…) from Settings → API Keys. Required for sold API calls outside the Mermail console.
Body
application/json
Mailbox address on an allowed Mermail or custom domain
Example:
Display name (also seeds settings.fromName)
Example:
"Acme Support"
Required for POST /api/v1/mailboxes
Example:
"ws_01abc"
Optional mailbox settings merged over defaults
Response
Mailbox created
Hosted alias primary key (also accepted as mailboxId)
Stable public route id; preferred mailboxId for agents and clients
⌘I