Update email account
curl --request PATCH \
--url https://app.gtm-api.com/email/v4/api/email-accounts/{sid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"display_name": "<string>",
"label": "<string>",
"signature_html": "<string>",
"track_opens": true,
"track_clicks": true,
"email_tracking_domain_sid": "<string>",
"sync_config": {},
"webhook_config": {}
}
'import requests
url = "https://app.gtm-api.com/email/v4/api/email-accounts/{sid}"
payload = {
"display_name": "<string>",
"label": "<string>",
"signature_html": "<string>",
"track_opens": True,
"track_clicks": True,
"email_tracking_domain_sid": "<string>",
"sync_config": {},
"webhook_config": {}
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
display_name: '<string>',
label: '<string>',
signature_html: '<string>',
track_opens: true,
track_clicks: true,
email_tracking_domain_sid: '<string>',
sync_config: {},
webhook_config: {}
})
};
fetch('https://app.gtm-api.com/email/v4/api/email-accounts/{sid}', 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/email/v4/api/email-accounts/{sid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'display_name' => '<string>',
'label' => '<string>',
'signature_html' => '<string>',
'track_opens' => true,
'track_clicks' => true,
'email_tracking_domain_sid' => '<string>',
'sync_config' => [
],
'webhook_config' => [
]
]),
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/email/v4/api/email-accounts/{sid}"
payload := strings.NewReader("{\n \"display_name\": \"<string>\",\n \"label\": \"<string>\",\n \"signature_html\": \"<string>\",\n \"track_opens\": true,\n \"track_clicks\": true,\n \"email_tracking_domain_sid\": \"<string>\",\n \"sync_config\": {},\n \"webhook_config\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://app.gtm-api.com/email/v4/api/email-accounts/{sid}")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"<string>\",\n \"label\": \"<string>\",\n \"signature_html\": \"<string>\",\n \"track_opens\": true,\n \"track_clicks\": true,\n \"email_tracking_domain_sid\": \"<string>\",\n \"sync_config\": {},\n \"webhook_config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/email/v4/api/email-accounts/{sid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"display_name\": \"<string>\",\n \"label\": \"<string>\",\n \"signature_html\": \"<string>\",\n \"track_opens\": true,\n \"track_clicks\": true,\n \"email_tracking_domain_sid\": \"<string>\",\n \"sync_config\": {},\n \"webhook_config\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "update",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"email_sending_domain_sid": "<string>",
"provider": "google",
"address": "<string>",
"display_name": "<string>",
"aliases": [
"<string>"
],
"status": "connecting",
"sending_paused_at": "<string>",
"sending_paused_reason": "manual",
"connection": {
"imap_host": "<string>",
"imap_port": 123,
"imap_encryption": "ssl",
"imap_username": "<string>",
"smtp_host": "<string>",
"smtp_port": 123,
"smtp_encryption": "ssl",
"smtp_username": "<string>"
},
"sending_limits": {
"daily_limit": 123,
"min_interval_seconds": 123,
"sending_window": {
"time_zone": "<string>",
"days": [
123
],
"start": "<string>",
"end": "<string>"
}
},
"warmup_config": {
"enabled": true,
"ramp_start_daily": 123,
"ramp_step_per_day": 123,
"target_daily": 123
},
"signature_html": "<string>",
"track_opens": true,
"track_clicks": true,
"email_tracking_domain_sid": "<string>",
"email_oauth_app_sid": "<string>",
"backfill_days": 123,
"last_messages_sync_at": "<string>",
"last_folders_sync_at": "<string>",
"connected_at": "<string>",
"reconnect_required_at": "<string>",
"sync_config": {},
"webhook_config": {},
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"sending_paused_until": "<string>",
"reconnect_reason": "<string>",
"email_box_sid": "<string>",
"label": "<string>",
"address_domain": "<string>",
"sent_today": 123,
"daily_cap_today": 123,
"warmup_day": 123,
"auth_suspect": {
"since": "<string>",
"failures": 123,
"next_try_at": "<string>",
"source": "<string>"
},
"subscription_hold_reason": "server_full",
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"updated_fields": [
"<string>"
],
"previous_values": {},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}email_accounts
Update email account
Change a mailbox’s settings: display name, label, signature, sending limits, the warmup ramp, open and click tracking, the tracking domain, sync cadence and which events it emits. Only the fields sent change. sending_limits and warmup_config are replaced whole: send every key of the object, with sending_window null for no window. Turning warmup on starts the ramp at ramp_start_daily. Credentials are not changed here: reconnect_email_account. To stop sending without touching limits use pause_email_account_sending. Requires can_update_email_accounts.
Contract:
- MCP tool
update_email_account, registry packagemcp.email/email_accounts, mountemail.accounts. - Operation
update, response envelopeupdate. - Flags: none.
PATCH
/
api
/
email-accounts
/
{sid}
Update email account
curl --request PATCH \
--url https://app.gtm-api.com/email/v4/api/email-accounts/{sid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"display_name": "<string>",
"label": "<string>",
"signature_html": "<string>",
"track_opens": true,
"track_clicks": true,
"email_tracking_domain_sid": "<string>",
"sync_config": {},
"webhook_config": {}
}
'import requests
url = "https://app.gtm-api.com/email/v4/api/email-accounts/{sid}"
payload = {
"display_name": "<string>",
"label": "<string>",
"signature_html": "<string>",
"track_opens": True,
"track_clicks": True,
"email_tracking_domain_sid": "<string>",
"sync_config": {},
"webhook_config": {}
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
display_name: '<string>',
label: '<string>',
signature_html: '<string>',
track_opens: true,
track_clicks: true,
email_tracking_domain_sid: '<string>',
sync_config: {},
webhook_config: {}
})
};
fetch('https://app.gtm-api.com/email/v4/api/email-accounts/{sid}', 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/email/v4/api/email-accounts/{sid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'display_name' => '<string>',
'label' => '<string>',
'signature_html' => '<string>',
'track_opens' => true,
'track_clicks' => true,
'email_tracking_domain_sid' => '<string>',
'sync_config' => [
],
'webhook_config' => [
]
]),
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/email/v4/api/email-accounts/{sid}"
payload := strings.NewReader("{\n \"display_name\": \"<string>\",\n \"label\": \"<string>\",\n \"signature_html\": \"<string>\",\n \"track_opens\": true,\n \"track_clicks\": true,\n \"email_tracking_domain_sid\": \"<string>\",\n \"sync_config\": {},\n \"webhook_config\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://app.gtm-api.com/email/v4/api/email-accounts/{sid}")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"<string>\",\n \"label\": \"<string>\",\n \"signature_html\": \"<string>\",\n \"track_opens\": true,\n \"track_clicks\": true,\n \"email_tracking_domain_sid\": \"<string>\",\n \"sync_config\": {},\n \"webhook_config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/email/v4/api/email-accounts/{sid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"display_name\": \"<string>\",\n \"label\": \"<string>\",\n \"signature_html\": \"<string>\",\n \"track_opens\": true,\n \"track_clicks\": true,\n \"email_tracking_domain_sid\": \"<string>\",\n \"sync_config\": {},\n \"webhook_config\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "update",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"email_sending_domain_sid": "<string>",
"provider": "google",
"address": "<string>",
"display_name": "<string>",
"aliases": [
"<string>"
],
"status": "connecting",
"sending_paused_at": "<string>",
"sending_paused_reason": "manual",
"connection": {
"imap_host": "<string>",
"imap_port": 123,
"imap_encryption": "ssl",
"imap_username": "<string>",
"smtp_host": "<string>",
"smtp_port": 123,
"smtp_encryption": "ssl",
"smtp_username": "<string>"
},
"sending_limits": {
"daily_limit": 123,
"min_interval_seconds": 123,
"sending_window": {
"time_zone": "<string>",
"days": [
123
],
"start": "<string>",
"end": "<string>"
}
},
"warmup_config": {
"enabled": true,
"ramp_start_daily": 123,
"ramp_step_per_day": 123,
"target_daily": 123
},
"signature_html": "<string>",
"track_opens": true,
"track_clicks": true,
"email_tracking_domain_sid": "<string>",
"email_oauth_app_sid": "<string>",
"backfill_days": 123,
"last_messages_sync_at": "<string>",
"last_folders_sync_at": "<string>",
"connected_at": "<string>",
"reconnect_required_at": "<string>",
"sync_config": {},
"webhook_config": {},
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"sending_paused_until": "<string>",
"reconnect_reason": "<string>",
"email_box_sid": "<string>",
"label": "<string>",
"address_domain": "<string>",
"sent_today": 123,
"daily_cap_today": 123,
"warmup_day": 123,
"auth_suspect": {
"since": "<string>",
"failures": 123,
"next_try_at": "<string>",
"source": "<string>"
},
"subscription_hold_reason": "server_full",
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"updated_fields": [
"<string>"
],
"previous_values": {},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}Authorizations
Headers
Body
application/json
Request body of update_email_account.