Partners

Start migrating a domain from your server

Creates the mailboxes that do not exist yet (password = the one in the file unless newPassword is given; existing mailboxes keep theirs), stores the source passwords encrypted and held, and queues the first copy. At most 500 rows. Pass expectedBytes from the test to be refused (422, STORAGE_DOES_NOT_FIT) before anything is created when the mail does not fit the customer's storage. Idempotent per address: the same rows again only refresh the stored source passwords and queue another sync. 403 when the domain is not verified yet. Requires partner:write.

post/customers/{id}/domains/{domain}/migrations

Request

Base URL: https://faivelo.com/api/partner
URL: https://faivelo.com/api/partner/customers/{id}/domains/{domain}/migrations
Auth: HTTP bearer

Path parameters

idstring required

Example:cmtumr8yj000bd7xabjjsnil8

The customer id returned when the customer was created

domainstring required

The customer's domain name, e.g. smiledental.example

Request body

csvstring

email,password[,newPassword], one mailbox per line; an optional header line; cells may be double-quoted

expectedBytesobject

Bytes per source address from the test, so create can refuse what does not fit before creating anything

Example request

{
  "source": {
    "host": "mail.yourserver.com"
  },
  "csv": "email,password\nana@smiledental.example,her-current-password"
}

Response

The migration with its first progress, and what happened per row

successboolean

Example response

{
  "success": true,
  "data": {
    "migration": {
      "source": {
        "host": "mail.yourserver.com"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.