Update mailbox settings
curl --request PUT \
--url https://console.mermail.app/api/v1/mailboxes/{mailboxId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"settings": {
"forwarding": {
"enabled": false,
"email": ""
},
"signature": {
"enabled": false,
"text": ""
},
"autoReply": {
"enabled": false,
"subject": "",
"message": ""
},
"agentAutoResponse": {
"requireApproval": true
},
"fromName": "Acme Support"
}
}
'import requests
url = "https://console.mermail.app/api/v1/mailboxes/{mailboxId}"
payload = { "settings": {
"forwarding": {
"enabled": False,
"email": ""
},
"signature": {
"enabled": False,
"text": ""
},
"autoReply": {
"enabled": False,
"subject": "",
"message": ""
},
"agentAutoResponse": { "requireApproval": True },
"fromName": "Acme Support"
} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
settings: {
forwarding: {enabled: false, email: ''},
signature: {enabled: false, text: ''},
autoReply: {enabled: false, subject: '', message: ''},
agentAutoResponse: {requireApproval: true},
fromName: 'Acme Support'
}
})
};
fetch('https://console.mermail.app/api/v1/mailboxes/{mailboxId}', 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/{mailboxId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'settings' => [
'forwarding' => [
'enabled' => false,
'email' => ''
],
'signature' => [
'enabled' => false,
'text' => ''
],
'autoReply' => [
'enabled' => false,
'subject' => '',
'message' => ''
],
'agentAutoResponse' => [
'requireApproval' => true
],
'fromName' => 'Acme Support'
]
]),
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/{mailboxId}"
payload := strings.NewReader("{\n \"settings\": {\n \"forwarding\": {\n \"enabled\": false,\n \"email\": \"\"\n },\n \"signature\": {\n \"enabled\": false,\n \"text\": \"\"\n },\n \"autoReply\": {\n \"enabled\": false,\n \"subject\": \"\",\n \"message\": \"\"\n },\n \"agentAutoResponse\": {\n \"requireApproval\": true\n },\n \"fromName\": \"Acme Support\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://console.mermail.app/api/v1/mailboxes/{mailboxId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"settings\": {\n \"forwarding\": {\n \"enabled\": false,\n \"email\": \"\"\n },\n \"signature\": {\n \"enabled\": false,\n \"text\": \"\"\n },\n \"autoReply\": {\n \"enabled\": false,\n \"subject\": \"\",\n \"message\": \"\"\n },\n \"agentAutoResponse\": {\n \"requireApproval\": true\n },\n \"fromName\": \"Acme Support\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.mermail.app/api/v1/mailboxes/{mailboxId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"settings\": {\n \"forwarding\": {\n \"enabled\": false,\n \"email\": \"\"\n },\n \"signature\": {\n \"enabled\": false,\n \"text\": \"\"\n },\n \"autoReply\": {\n \"enabled\": false,\n \"subject\": \"\",\n \"message\": \"\"\n },\n \"agentAutoResponse\": {\n \"requireApproval\": true\n },\n \"fromName\": \"Acme Support\"\n }\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 Support",
"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": "Unauthorized"
}{
"error": "Invalid request"
}{
"error": "Forbidden"
}{
"error": "Too many requests"
}Mailboxes
Update mailbox settings
Plans: Free · Developer · Enterprise
Replaces the mailbox settings JSON object. Body shape is { settings } only — there is no top-level name field on this route. Requires mailbox admin.
API credits: 2 (write).
PUT
https://console.mermail.app
/
api
/
v1
/
mailboxes
/
{mailboxId}
Update mailbox settings
curl --request PUT \
--url https://console.mermail.app/api/v1/mailboxes/{mailboxId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"settings": {
"forwarding": {
"enabled": false,
"email": ""
},
"signature": {
"enabled": false,
"text": ""
},
"autoReply": {
"enabled": false,
"subject": "",
"message": ""
},
"agentAutoResponse": {
"requireApproval": true
},
"fromName": "Acme Support"
}
}
'import requests
url = "https://console.mermail.app/api/v1/mailboxes/{mailboxId}"
payload = { "settings": {
"forwarding": {
"enabled": False,
"email": ""
},
"signature": {
"enabled": False,
"text": ""
},
"autoReply": {
"enabled": False,
"subject": "",
"message": ""
},
"agentAutoResponse": { "requireApproval": True },
"fromName": "Acme Support"
} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
settings: {
forwarding: {enabled: false, email: ''},
signature: {enabled: false, text: ''},
autoReply: {enabled: false, subject: '', message: ''},
agentAutoResponse: {requireApproval: true},
fromName: 'Acme Support'
}
})
};
fetch('https://console.mermail.app/api/v1/mailboxes/{mailboxId}', 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/{mailboxId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'settings' => [
'forwarding' => [
'enabled' => false,
'email' => ''
],
'signature' => [
'enabled' => false,
'text' => ''
],
'autoReply' => [
'enabled' => false,
'subject' => '',
'message' => ''
],
'agentAutoResponse' => [
'requireApproval' => true
],
'fromName' => 'Acme Support'
]
]),
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/{mailboxId}"
payload := strings.NewReader("{\n \"settings\": {\n \"forwarding\": {\n \"enabled\": false,\n \"email\": \"\"\n },\n \"signature\": {\n \"enabled\": false,\n \"text\": \"\"\n },\n \"autoReply\": {\n \"enabled\": false,\n \"subject\": \"\",\n \"message\": \"\"\n },\n \"agentAutoResponse\": {\n \"requireApproval\": true\n },\n \"fromName\": \"Acme Support\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://console.mermail.app/api/v1/mailboxes/{mailboxId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"settings\": {\n \"forwarding\": {\n \"enabled\": false,\n \"email\": \"\"\n },\n \"signature\": {\n \"enabled\": false,\n \"text\": \"\"\n },\n \"autoReply\": {\n \"enabled\": false,\n \"subject\": \"\",\n \"message\": \"\"\n },\n \"agentAutoResponse\": {\n \"requireApproval\": true\n },\n \"fromName\": \"Acme Support\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.mermail.app/api/v1/mailboxes/{mailboxId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"settings\": {\n \"forwarding\": {\n \"enabled\": false,\n \"email\": \"\"\n },\n \"signature\": {\n \"enabled\": false,\n \"text\": \"\"\n },\n \"autoReply\": {\n \"enabled\": false,\n \"subject\": \"\",\n \"message\": \"\"\n },\n \"agentAutoResponse\": {\n \"requireApproval\": true\n },\n \"fromName\": \"Acme Support\"\n }\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 Support",
"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": "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.
Path Parameters
Mailbox public_id (UUID), hosted alias id, or current email
Body
application/json
Full settings object to store on the mailbox
Example:
{
"forwarding": { "enabled": false, "email": "" },
"signature": { "enabled": false, "text": "" },
"autoReply": {
"enabled": false,
"subject": "",
"message": ""
},
"agentAutoResponse": { "requireApproval": true },
"fromName": "Acme Support"
}
Response
Success
The response is of type object.
⌘I