Update custom label
curl --request PUT \
--url https://console.mermail.app/api/v1/mailboxes/{mailboxId}/custom-labels/{labelId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"name": "VIP+"
}'import requests
url = "https://console.mermail.app/api/v1/mailboxes/{mailboxId}/custom-labels/{labelId}"
payload = { "name": "VIP+" }
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({name: 'VIP+'})
};
fetch('https://console.mermail.app/api/v1/mailboxes/{mailboxId}/custom-labels/{labelId}', 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}/custom-labels/{labelId}",
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([
'name' => 'VIP+'
]),
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}/custom-labels/{labelId}"
payload := strings.NewReader("{\n \"name\": \"VIP+\"\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}/custom-labels/{labelId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"VIP+\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.mermail.app/api/v1/mailboxes/{mailboxId}/custom-labels/{labelId}")
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 \"name\": \"VIP+\"\n}"
response = http.request(request)
puts response.read_body{
"id": "lbl_1",
"mailbox_id": "[email protected]",
"name": "VIP+",
"slug": "vip",
"rules": "from:[email protected]",
"color": "#43c9cb",
"sort_order": 0,
"created_at": "2026-07-14T09:00:00.000Z",
"updated_at": "2026-07-14T09:00:00.000Z"
}{
"error": "Unauthorized"
}{
"error": "Invalid request"
}{
"error": "Forbidden"
}{
"error": "Too many requests"
}Emails
Update custom label
Plans: Free · Developer · Enterprise
Updates a custom label (name, rules, and/or color). Mailbox admin role required.
API credits: 2 (write).
PUT
https://console.mermail.app
/
api
/
v1
/
mailboxes
/
{mailboxId}
/
custom-labels
/
{labelId}
Update custom label
curl --request PUT \
--url https://console.mermail.app/api/v1/mailboxes/{mailboxId}/custom-labels/{labelId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"name": "VIP+"
}'import requests
url = "https://console.mermail.app/api/v1/mailboxes/{mailboxId}/custom-labels/{labelId}"
payload = { "name": "VIP+" }
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({name: 'VIP+'})
};
fetch('https://console.mermail.app/api/v1/mailboxes/{mailboxId}/custom-labels/{labelId}', 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}/custom-labels/{labelId}",
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([
'name' => 'VIP+'
]),
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}/custom-labels/{labelId}"
payload := strings.NewReader("{\n \"name\": \"VIP+\"\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}/custom-labels/{labelId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"VIP+\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.mermail.app/api/v1/mailboxes/{mailboxId}/custom-labels/{labelId}")
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 \"name\": \"VIP+\"\n}"
response = http.request(request)
puts response.read_body{
"id": "lbl_1",
"mailbox_id": "[email protected]",
"name": "VIP+",
"slug": "vip",
"rules": "from:[email protected]",
"color": "#43c9cb",
"sort_order": 0,
"created_at": "2026-07-14T09:00:00.000Z",
"updated_at": "2026-07-14T09:00:00.000Z"
}{
"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
Label id
Response
Success
The response is of type object.
⌘I