curl --request POST \
--url https://app.gtm-api.com/id/v4/api/email-boxes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"name": "<string>",
"copy_settings_from": "<string>"
}
'import requests
url = "https://app.gtm-api.com/id/v4/api/email-boxes"
payload = {
"name": "<string>",
"copy_settings_from": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({name: '<string>', copy_settings_from: '<string>'})
};
fetch('https://app.gtm-api.com/id/v4/api/email-boxes', 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://app.gtm-api.com/id/v4/api/email-boxes",
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([
'name' => '<string>',
'copy_settings_from' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <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://app.gtm-api.com/id/v4/api/email-boxes"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"copy_settings_from\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<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://app.gtm-api.com/id/v4/api/email-boxes")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"copy_settings_from\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/id/v4/api/email-boxes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"copy_settings_from\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "create",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"name": "<string>",
"plan": "starter",
"location": "hel1",
"status": "provisioning",
"suspended_reason": "payment_failed",
"complimentary": true,
"seats_cap": 1,
"seats_used": 1,
"ipv4": "<string>",
"release": "<string>",
"run": {
"verb": "<string>",
"status": "<string>",
"phase": "<string>",
"phase_index": 1,
"phase_count": 1,
"started_at": "<string>",
"error_code": "<string>"
},
"price": {
"amount": "<string>",
"currency": "<string>",
"interval": "<string>"
},
"renews_at": "<string>",
"paid_through": "<string>",
"failed_error_code": "<string>",
"created_at": "<string>",
"provisioned_at": "<string>",
"suspended_at": "<string>",
"updated_at": "<string>"
},
"already_exists": true,
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
},
"checkout": {
"client_side_token": "<string>",
"paddle_environment": "<string>",
"paddle_transaction_id": "<string>"
}
}Buy email server
Buy an email server: one unit of the plan’s price on the workspace’s subscription. Spends money. Two calls through MCP. The first, without commit_token, changes nothing; preview_result quotes it: payment (charged_now: amount_due_now, prorated, to the subscription’s card; checkout: no subscription, nothing charged, a Paddle checkout only the app opens; kept_seat: a deleted server’s seat pays, free), next_amount (recurring) and available. Show the user the money; do not commit when available is false; status unanswered: no quote came back, say so. The second, same arguments plus commit_token, buys: item is the new server in provisioning, run shows the build. REST buys on the call; preview: POST /api/email-boxes/preview-create. The same ask within 10 minutes buys nothing: that server, already_exists. 409 payment_declined, email_box_purchase_in_progress (a purchase is unfinished, nothing charged); 503 email_server_out_of_stock, email_server_stock_unknown, email_servers_not_offered. Requires can_manage_billing.
Contract:
- MCP tool
create_email_box, registry packagemcp.id/email_boxes, mountid.billing. - Operation
create, response envelopecreate. - Flags: dangerous: the MCP layer gates it behind a preview/commit token, and the effect cannot be undone through this API.
curl --request POST \
--url https://app.gtm-api.com/id/v4/api/email-boxes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"name": "<string>",
"copy_settings_from": "<string>"
}
'import requests
url = "https://app.gtm-api.com/id/v4/api/email-boxes"
payload = {
"name": "<string>",
"copy_settings_from": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({name: '<string>', copy_settings_from: '<string>'})
};
fetch('https://app.gtm-api.com/id/v4/api/email-boxes', 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://app.gtm-api.com/id/v4/api/email-boxes",
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([
'name' => '<string>',
'copy_settings_from' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <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://app.gtm-api.com/id/v4/api/email-boxes"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"copy_settings_from\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<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://app.gtm-api.com/id/v4/api/email-boxes")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"copy_settings_from\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/id/v4/api/email-boxes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"copy_settings_from\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "create",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"name": "<string>",
"plan": "starter",
"location": "hel1",
"status": "provisioning",
"suspended_reason": "payment_failed",
"complimentary": true,
"seats_cap": 1,
"seats_used": 1,
"ipv4": "<string>",
"release": "<string>",
"run": {
"verb": "<string>",
"status": "<string>",
"phase": "<string>",
"phase_index": 1,
"phase_count": 1,
"started_at": "<string>",
"error_code": "<string>"
},
"price": {
"amount": "<string>",
"currency": "<string>",
"interval": "<string>"
},
"renews_at": "<string>",
"paid_through": "<string>",
"failed_error_code": "<string>",
"created_at": "<string>",
"provisioned_at": "<string>",
"suspended_at": "<string>",
"updated_at": "<string>"
},
"already_exists": true,
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
},
"checkout": {
"client_side_token": "<string>",
"paddle_environment": "<string>",
"paddle_transaction_id": "<string>"
}
}Authorizations
Body
Request body of create_email_box.
Response
create success envelope.