Connect an IMAP mailbox to a sender profile
curl --request POST \
--url https://beta.getsales.io/unibox/v1/api/sender-profiles/{sid}/mailboxes/connect-imap \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"address": "jsmith@example.com",
"connection": {
"imap_host": "<string>",
"imap_port": 32768,
"imap_username": "<string>",
"smtp_host": "<string>",
"smtp_port": 32768,
"smtp_username": "<string>"
},
"imap_password": "<string>",
"smtp_password": "<string>",
"display_name": "<string>",
"backfill_days": 1825,
"history_since": "<string>"
}
'import requests
url = "https://beta.getsales.io/unibox/v1/api/sender-profiles/{sid}/mailboxes/connect-imap"
payload = {
"address": "jsmith@example.com",
"connection": {
"imap_host": "<string>",
"imap_port": 32768,
"imap_username": "<string>",
"smtp_host": "<string>",
"smtp_port": 32768,
"smtp_username": "<string>"
},
"imap_password": "<string>",
"smtp_password": "<string>",
"display_name": "<string>",
"backfill_days": 1825,
"history_since": "<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({
address: 'jsmith@example.com',
connection: {
imap_host: '<string>',
imap_port: 32768,
imap_username: '<string>',
smtp_host: '<string>',
smtp_port: 32768,
smtp_username: '<string>'
},
imap_password: '<string>',
smtp_password: '<string>',
display_name: '<string>',
backfill_days: 1825,
history_since: '<string>'
})
};
fetch('https://beta.getsales.io/unibox/v1/api/sender-profiles/{sid}/mailboxes/connect-imap', 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://beta.getsales.io/unibox/v1/api/sender-profiles/{sid}/mailboxes/connect-imap",
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([
'address' => 'jsmith@example.com',
'connection' => [
'imap_host' => '<string>',
'imap_port' => 32768,
'imap_username' => '<string>',
'smtp_host' => '<string>',
'smtp_port' => 32768,
'smtp_username' => '<string>'
],
'imap_password' => '<string>',
'smtp_password' => '<string>',
'display_name' => '<string>',
'backfill_days' => 1825,
'history_since' => '<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://beta.getsales.io/unibox/v1/api/sender-profiles/{sid}/mailboxes/connect-imap"
payload := strings.NewReader("{\n \"address\": \"jsmith@example.com\",\n \"connection\": {\n \"imap_host\": \"<string>\",\n \"imap_port\": 32768,\n \"imap_username\": \"<string>\",\n \"smtp_host\": \"<string>\",\n \"smtp_port\": 32768,\n \"smtp_username\": \"<string>\"\n },\n \"imap_password\": \"<string>\",\n \"smtp_password\": \"<string>\",\n \"display_name\": \"<string>\",\n \"backfill_days\": 1825,\n \"history_since\": \"<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://beta.getsales.io/unibox/v1/api/sender-profiles/{sid}/mailboxes/connect-imap")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"address\": \"jsmith@example.com\",\n \"connection\": {\n \"imap_host\": \"<string>\",\n \"imap_port\": 32768,\n \"imap_username\": \"<string>\",\n \"smtp_host\": \"<string>\",\n \"smtp_port\": 32768,\n \"smtp_username\": \"<string>\"\n },\n \"imap_password\": \"<string>\",\n \"smtp_password\": \"<string>\",\n \"display_name\": \"<string>\",\n \"backfill_days\": 1825,\n \"history_since\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/unibox/v1/api/sender-profiles/{sid}/mailboxes/connect-imap")
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 \"address\": \"jsmith@example.com\",\n \"connection\": {\n \"imap_host\": \"<string>\",\n \"imap_port\": 32768,\n \"imap_username\": \"<string>\",\n \"smtp_host\": \"<string>\",\n \"smtp_port\": 32768,\n \"smtp_username\": \"<string>\"\n },\n \"imap_password\": \"<string>\",\n \"smtp_password\": \"<string>\",\n \"display_name\": \"<string>\",\n \"backfill_days\": 1825,\n \"history_since\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "action",
"action": "<string>",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"name": "<string>",
"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>"
},
"label": "<string>",
"linkedin_account_sid": "<string>",
"linkedin_source": "cloud",
"linkedin_status": "active",
"linkedin_status_reason": "<string>",
"linkedin_has_sn": true,
"linkedin_recruiter_status": "active",
"linkedin_history_since": "<string>",
"linkedin_history_scope": "all",
"email_account_sid": "<string>",
"avatar_url": "<string>",
"assignee_user_sid": "<string>",
"history_sync": {
"status": "pending",
"requested_at": "<string>",
"started_at": "<string>",
"finished_at": "<string>",
"threads_seen": 1,
"threads_imported": 1,
"messages_imported": 1,
"skipped": 1,
"synced_through": "<string>",
"error": "<string>"
},
"mailboxes": [
{
"email_account_sid": "<string>",
"address": "<string>",
"display_name": "<string>",
"provider": "<string>",
"status": "<string>",
"status_reason": "<string>",
"is_primary": true,
"sending_limits": {
"daily_limit": 123,
"min_interval_seconds": 123,
"sending_window": {}
},
"warmup_config": {
"enabled": true,
"ramp_start_daily": 123,
"ramp_step_per_day": 123,
"target_daily": 123
},
"signature_html": "<string>",
"bcc": [
"<string>"
],
"track_opens": true,
"track_clicks": true,
"email_tracking_domain_sid": "<string>",
"history_since": "<string>",
"history_scope": "all",
"connected_at": "<string>",
"synced_at": "<string>"
}
],
"deleted_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>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"result": {
"mailboxes": [
{
"email_account_sid": "<string>",
"address": "<string>",
"display_name": "<string>",
"provider": "<string>",
"status": "<string>",
"status_reason": "<string>",
"is_primary": true,
"sending_limits": {
"daily_limit": 123,
"min_interval_seconds": 123,
"sending_window": {}
},
"warmup_config": {
"enabled": true,
"ramp_start_daily": 123,
"ramp_step_per_day": 123,
"target_daily": 123
},
"signature_html": "<string>",
"bcc": [
"<string>"
],
"track_opens": true,
"track_clicks": true,
"email_tracking_domain_sid": "<string>",
"history_since": "<string>",
"history_scope": "all",
"connected_at": "<string>",
"synced_at": "<string>"
}
]
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}sender_profiles
Connect an IMAP mailbox to a sender profile
Create an IMAP / SMTP mailbox on gtm from typed credentials and attach it to this sender profile. Both passwords ride through to gtm, which stores them; nothing of them is kept or readable here. backfill_days is how much existing mail gtm pulls at connect; history_since and history_scope bound what of it reaches the inbox. For Google or Microsoft use start_sender_profile_mailbox_connect; for a mailbox gtm already holds, attach_sender_profile_mailbox.
Contract:
- MCP tool
connect_sender_profile_imap_mailbox, registry packagemcp.unibox/sender_profiles, mountunibox.sender-profile-mailboxes. - Operation
action, response envelopeaction. - Flags: none.
POST
/
api
/
sender-profiles
/
{sid}
/
mailboxes
/
connect-imap
Connect an IMAP mailbox to a sender profile
curl --request POST \
--url https://beta.getsales.io/unibox/v1/api/sender-profiles/{sid}/mailboxes/connect-imap \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"address": "jsmith@example.com",
"connection": {
"imap_host": "<string>",
"imap_port": 32768,
"imap_username": "<string>",
"smtp_host": "<string>",
"smtp_port": 32768,
"smtp_username": "<string>"
},
"imap_password": "<string>",
"smtp_password": "<string>",
"display_name": "<string>",
"backfill_days": 1825,
"history_since": "<string>"
}
'import requests
url = "https://beta.getsales.io/unibox/v1/api/sender-profiles/{sid}/mailboxes/connect-imap"
payload = {
"address": "jsmith@example.com",
"connection": {
"imap_host": "<string>",
"imap_port": 32768,
"imap_username": "<string>",
"smtp_host": "<string>",
"smtp_port": 32768,
"smtp_username": "<string>"
},
"imap_password": "<string>",
"smtp_password": "<string>",
"display_name": "<string>",
"backfill_days": 1825,
"history_since": "<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({
address: 'jsmith@example.com',
connection: {
imap_host: '<string>',
imap_port: 32768,
imap_username: '<string>',
smtp_host: '<string>',
smtp_port: 32768,
smtp_username: '<string>'
},
imap_password: '<string>',
smtp_password: '<string>',
display_name: '<string>',
backfill_days: 1825,
history_since: '<string>'
})
};
fetch('https://beta.getsales.io/unibox/v1/api/sender-profiles/{sid}/mailboxes/connect-imap', 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://beta.getsales.io/unibox/v1/api/sender-profiles/{sid}/mailboxes/connect-imap",
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([
'address' => 'jsmith@example.com',
'connection' => [
'imap_host' => '<string>',
'imap_port' => 32768,
'imap_username' => '<string>',
'smtp_host' => '<string>',
'smtp_port' => 32768,
'smtp_username' => '<string>'
],
'imap_password' => '<string>',
'smtp_password' => '<string>',
'display_name' => '<string>',
'backfill_days' => 1825,
'history_since' => '<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://beta.getsales.io/unibox/v1/api/sender-profiles/{sid}/mailboxes/connect-imap"
payload := strings.NewReader("{\n \"address\": \"jsmith@example.com\",\n \"connection\": {\n \"imap_host\": \"<string>\",\n \"imap_port\": 32768,\n \"imap_username\": \"<string>\",\n \"smtp_host\": \"<string>\",\n \"smtp_port\": 32768,\n \"smtp_username\": \"<string>\"\n },\n \"imap_password\": \"<string>\",\n \"smtp_password\": \"<string>\",\n \"display_name\": \"<string>\",\n \"backfill_days\": 1825,\n \"history_since\": \"<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://beta.getsales.io/unibox/v1/api/sender-profiles/{sid}/mailboxes/connect-imap")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"address\": \"jsmith@example.com\",\n \"connection\": {\n \"imap_host\": \"<string>\",\n \"imap_port\": 32768,\n \"imap_username\": \"<string>\",\n \"smtp_host\": \"<string>\",\n \"smtp_port\": 32768,\n \"smtp_username\": \"<string>\"\n },\n \"imap_password\": \"<string>\",\n \"smtp_password\": \"<string>\",\n \"display_name\": \"<string>\",\n \"backfill_days\": 1825,\n \"history_since\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/unibox/v1/api/sender-profiles/{sid}/mailboxes/connect-imap")
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 \"address\": \"jsmith@example.com\",\n \"connection\": {\n \"imap_host\": \"<string>\",\n \"imap_port\": 32768,\n \"imap_username\": \"<string>\",\n \"smtp_host\": \"<string>\",\n \"smtp_port\": 32768,\n \"smtp_username\": \"<string>\"\n },\n \"imap_password\": \"<string>\",\n \"smtp_password\": \"<string>\",\n \"display_name\": \"<string>\",\n \"backfill_days\": 1825,\n \"history_since\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "action",
"action": "<string>",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"name": "<string>",
"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>"
},
"label": "<string>",
"linkedin_account_sid": "<string>",
"linkedin_source": "cloud",
"linkedin_status": "active",
"linkedin_status_reason": "<string>",
"linkedin_has_sn": true,
"linkedin_recruiter_status": "active",
"linkedin_history_since": "<string>",
"linkedin_history_scope": "all",
"email_account_sid": "<string>",
"avatar_url": "<string>",
"assignee_user_sid": "<string>",
"history_sync": {
"status": "pending",
"requested_at": "<string>",
"started_at": "<string>",
"finished_at": "<string>",
"threads_seen": 1,
"threads_imported": 1,
"messages_imported": 1,
"skipped": 1,
"synced_through": "<string>",
"error": "<string>"
},
"mailboxes": [
{
"email_account_sid": "<string>",
"address": "<string>",
"display_name": "<string>",
"provider": "<string>",
"status": "<string>",
"status_reason": "<string>",
"is_primary": true,
"sending_limits": {
"daily_limit": 123,
"min_interval_seconds": 123,
"sending_window": {}
},
"warmup_config": {
"enabled": true,
"ramp_start_daily": 123,
"ramp_step_per_day": 123,
"target_daily": 123
},
"signature_html": "<string>",
"bcc": [
"<string>"
],
"track_opens": true,
"track_clicks": true,
"email_tracking_domain_sid": "<string>",
"history_since": "<string>",
"history_scope": "all",
"connected_at": "<string>",
"synced_at": "<string>"
}
],
"deleted_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>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"result": {
"mailboxes": [
{
"email_account_sid": "<string>",
"address": "<string>",
"display_name": "<string>",
"provider": "<string>",
"status": "<string>",
"status_reason": "<string>",
"is_primary": true,
"sending_limits": {
"daily_limit": 123,
"min_interval_seconds": 123,
"sending_window": {}
},
"warmup_config": {
"enabled": true,
"ramp_start_daily": 123,
"ramp_step_per_day": 123,
"target_daily": 123
},
"signature_html": "<string>",
"bcc": [
"<string>"
],
"track_opens": true,
"track_clicks": true,
"email_tracking_domain_sid": "<string>",
"history_since": "<string>",
"history_scope": "all",
"connected_at": "<string>",
"synced_at": "<string>"
}
]
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}Authorizations
Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.
Team scope for tokens that do not carry one. Ignored when the token already names a team.
Path Parameters
Sender profile sid (ub_sp_…).
Required string length:
18Pattern:
^ub_sp_Body
application/json
Request body of connect_sender_profile_imap_mailbox.
The mailbox address to create on gtm.
Maximum string length:
320The server settings, both halves required: gtm reads with IMAP and sends with SMTP.
Show child attributes
Show child attributes
Stored by gtm.service.email, never here. Sent once, on this call.
Maximum string length:
1024Stored by gtm.service.email, never here. Often the same value as imap_password, but both are required.
Maximum string length:
1024The From name; null = the address alone.
Maximum string length:
255How many days of existing mail gtm itself pulls from the server at connect; 0 = none, null = the gtm default. history_since is the bound on THIS side, over what gtm holds.
Required range:
0 <= x <= 3650The mailbox's history window: import its mail from this day (YYYY-MM-DD) on, into the inbox and onto the linked people's activity, or nothing older than the connect with now; omitted or null = all of it.
Pattern:
^(now|\d{4}-\d{2}-\d{2})$The mailbox's import scope: playtable_people (omitted or null, the default) takes only the threads with a person the workspace keeps in a playtable, all every thread.
Available options:
all, playtable_people Response
action success envelope.
Available options:
true Available options:
action kebab-case verb; matches the route segment.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes