Sync a mailbox's inbox now

Runs one incremental IMAP pass immediately instead of waiting for the scheduler (default: every 2 minutes). Processes up to 50 messages inside a ~9 second budget; large backlogs drain across several calls (remaining > 0, or partial: true when the provider was slow). Progress is always saved, so repeating the call is safe.

curl -X POST "https://api.supasend.io/v1/mailboxes/507f1f77bcf86cd799439011/sync" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

import requests
import json

url = "https://api.supasend.io/v1/mailboxes/507f1f77bcf86cd799439011/sync"
headers = {
  "Content-Type": "application/json",
  "X-API-Key": "YOUR_API_KEY"
}

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

const response = await fetch("https://api.supasend.io/v1/mailboxes/507f1f77bcf86cd799439011/sync", {
  method: "POST",
  headers: {
  "Content-Type": "application/json",
  "X-API-Key": "YOUR_API_KEY"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("POST", "https://api.supasend.io/v1/mailboxes/507f1f77bcf86cd799439011/sync", nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("X-API-Key", "YOUR_API_KEY")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://api.supasend.io/v1/mailboxes/507f1f77bcf86cd799439011/sync')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['X-API-Key'] = 'YOUR_API_KEY'

response = http.request(request)
puts response.body

{
  "mailbox_id": "example_string",
  "fetched": 42,
  "stored": 42,
  "skipped": 42,
  "replies": 42,
  "bounces": 42,
  "auto_replies": 42,
  "bulk": 42,
  "remaining": 42,
  "partial": true,
  "synced_at": "2024-12-25T10:00:00Z"
}

{
  "error": "Bad Request",
  "message": "The request contains invalid parameters or malformed data",
  "code": 400,
  "details": [
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ]
}