Update mailbox
curl --request PUT \
--url https://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"signature": "<string>",
"folderUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"signature": "<string>",
"folderUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: '<string>',
lastName: '<string>',
signature: '<string>',
folderUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}', 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://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}",
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([
'firstName' => '<string>',
'lastName' => '<string>',
'signature' => '<string>',
'folderUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"signature\": \"<string>\",\n \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"signature\": \"<string>\",\n \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"signature\": \"<string>\",\n \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"mailbox": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domainUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"folderUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "mailpool",
"meta": {},
"credentials": {
"smtp": {
"host": "<string>",
"port": 123,
"username": "<string>",
"password": {
"type": "encryption",
"isEncrypted": true,
"value": "<string>"
},
"isSecure": true
},
"imap": {
"host": "<string>",
"port": 123,
"username": "<string>",
"password": {
"type": "encryption",
"isEncrypted": true,
"value": "<string>"
},
"isSecure": true
}
},
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"signature": "<string>",
"errorCode": "<string>",
"errorMessage": "<string>",
"warmupDailyTarget": 123,
"warmupStartedAt": "<string>",
"dailySendLimit": 20,
"userUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"chargedUntil": "<string>",
"inboundUidValidity": 0,
"inboundLastUid": 0,
"inboundJunkUidValidity": 0,
"inboundJunkLastUid": 0,
"inboundSyncedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>"
}
}Mailbox Management - Mailboxes
Update mailbox
Update a mailbox’s sender name, signature, or folder. Domain, username and type are create-only
PUT
/
mailboxManagement
/
mailboxes
/
{uuid}
Update mailbox
curl --request PUT \
--url https://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"signature": "<string>",
"folderUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"signature": "<string>",
"folderUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: '<string>',
lastName: '<string>',
signature: '<string>',
folderUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}', 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://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}",
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([
'firstName' => '<string>',
'lastName' => '<string>',
'signature' => '<string>',
'folderUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"signature\": \"<string>\",\n \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"signature\": \"<string>\",\n \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"signature\": \"<string>\",\n \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"mailbox": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domainUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"folderUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "mailpool",
"meta": {},
"credentials": {
"smtp": {
"host": "<string>",
"port": 123,
"username": "<string>",
"password": {
"type": "encryption",
"isEncrypted": true,
"value": "<string>"
},
"isSecure": true
},
"imap": {
"host": "<string>",
"port": 123,
"username": "<string>",
"password": {
"type": "encryption",
"isEncrypted": true,
"value": "<string>"
},
"isSecure": true
}
},
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"signature": "<string>",
"errorCode": "<string>",
"errorMessage": "<string>",
"warmupDailyTarget": 123,
"warmupStartedAt": "<string>",
"dailySendLimit": 20,
"userUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"chargedUntil": "<string>",
"inboundUidValidity": 0,
"inboundLastUid": 0,
"inboundJunkUidValidity": 0,
"inboundJunkLastUid": 0,
"inboundSyncedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Mailbox identifier.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$Body
application/json
Request body schema.
Sender first name shown in the From header.
Required string length:
1 - 64Sender last name shown in the From header.
Required string length:
1 - 64HTML signature stored on the mailbox. Null clears it. Not yet appended to outgoing messages.
Maximum string length:
10000Folder to move the mailbox into. Null means the root.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$Response
Successful response
Updated mailbox.
Show child attributes
Show child attributes
Was this page helpful?
⌘I

