---
title: "Import an existing mailbox over IMAP (mailcow syncjob). The source password goes straight to mailcow and is never stored"
method: POST
path: "/email/mailboxes/{mailboxId}/sync-jobs"
tags: ["Email"]
---

# Import an existing mailbox over IMAP (mailcow syncjob). The source password goes straight to mailcow and is never stored

`POST /email/mailboxes/{mailboxId}/sync-jobs`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/email/mailboxes/{mailboxId}/sync-jobs`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Path parameters

- `mailboxId` string, uuid, required

## Request body

- object
  - `mailboxId` string, uuid, required
  - `host` string, required: source IMAP host
  - `port` integer
  - `encryption` 'ssl' | 'tls' | 'plain'
  - `username` string, required
  - `password` string, required: sent straight to the mail server; not stored by us
  - `deleteFromSource` boolean: delete messages on the source after they are copied

## Response `201`

Started

- object
  - `id` string, uuid, required
  - `mailboxId` string, uuid, required
  - `host` string, required
  - `port` integer, required
  - `encryption` 'ssl' | 'tls' | 'plain', required
  - `username` string, required
  - `mailcowSyncJobId` integer, nullable, required
  - `status` 'pending' | 'running' | 'done' | 'error', required
  - `lastMessage` string, nullable, required
  - `deleteFromSource` boolean, required
  - `createdAt` string, required: ISO-8601 timestamp
  - `updatedAt` string, required: ISO-8601 timestamp

## Other responses

- `400`: Invalid request (code invalid_request)
- `401`: Missing or invalid session/token (code unauthorized)
- `403`: Authenticated but not permitted (code forbidden)
- `404`: Not found or not visible to the caller (code not_found)
- `409`: Conflicting state (code conflict)
- `429`: Too many requests (code rate_limited); see Retry-After
- `501`: Not available on this server (code not_configured)
- `503`: Mail server or sending service unavailable (code provider_unavailable)

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)