Start mailbox warm-up - Cargo | GTM Infrastructure for AI Agents

Start mailbox warm-up

curl --request POST \
  --url https://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}/warmup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dailyTarget": 39
}
'

import requests

url = "https://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}/warmup"

payload = { "dailyTarget": 39 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({dailyTarget: 39})
};

fetch('https://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}/warmup', 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}/warmup",
  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([
    'dailyTarget' => 39
  ]),
  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}/warmup"

	payload := strings.NewReader("{\n  \"dailyTarget\": 39\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}/warmup")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dailyTarget\": 39\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}/warmup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dailyTarget\": 39\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>",
    "type": "google",
    "transport": "smtp",
    "status": "pending",
    "errorCode": "<string>",
    "errorMessage": "<string>",
    "warmupStatus": "disabled",
    "warmupDailyTarget": 20,
    "warmupStartedAt": "<string>",
    "dailySendLimit": 20,
    "userUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "chargedUntil": "<string>",
    "inboundUidValidity": 0,
    "inboundLastUid": 0,
    "inboundJunkUidValidity": 0,
    "inboundJunkLastUid": 0,
    "inboundSyncedAt": "<string>",
    "statusRefreshedAt": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>"
  }
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

POST

mailboxManagement

mailboxes

{uuid}

warmup

Start mailbox warm-up

curl --request POST \
  --url https://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}/warmup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dailyTarget": 39
}
'

import requests

url = "https://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}/warmup"

payload = { "dailyTarget": 39 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({dailyTarget: 39})
};

fetch('https://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}/warmup', 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}/warmup",
  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([
    'dailyTarget' => 39
  ]),
  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}/warmup"

	payload := strings.NewReader("{\n  \"dailyTarget\": 39\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}/warmup")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dailyTarget\": 39\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/mailboxManagement/mailboxes/{uuid}/warmup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dailyTarget\": 39\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>",
    "type": "google",
    "transport": "smtp",
    "status": "pending",
    "errorCode": "<string>",
    "errorMessage": "<string>",
    "warmupStatus": "disabled",
    "warmupDailyTarget": 20,
    "warmupStartedAt": "<string>",
    "dailySendLimit": 20,
    "userUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "chargedUntil": "<string>",
    "inboundUidValidity": 0,
    "inboundLastUid": 0,
    "inboundJunkUidValidity": 0,
    "inboundJunkLastUid": 0,
    "inboundSyncedAt": "<string>",
    "statusRefreshedAt": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>"
  }
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

Authorizations

Authorization

string

header

required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Headers

Idempotency-Key

string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255

Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Path Parameters

uuid

string<uuid>

required

Mailbox identifier.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

Request body schema.

dailyTarget

integer

Warm-up messages per day at full ramp. Defaults to the outreach ceiling when omitted.

Required range: x <= 40

Response

Start mailbox warm-up

mailbox

Mailbox · object

required

Mailbox with warm-up running.

Show child attributes