/migrations/{id}/mailboxes (POST)

POST

/migrations/{id}/mailboxes

curl --request POST \
  --url https://example.com/api/v1/migrations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/mailboxes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "mailboxes": [ { "sourceAddress": "example", "targetMailboxId": null, "sourcePassword": "example" } ] }'

Authorizations

• bearer

Parameters

Path Parameters

id

required

string format: uuid

/^([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)$/

Request Body^required

Media typeapplication/json

object

mailboxes

required

Array<object>

>= 1 items <= 1000 items

object

sourceAddress

required

string

>= 1 characters <= 320 characters

targetMailboxId

Any of:

string

string format: uuid

/^([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)$/

null

null

sourcePassword

string

>= 1 characters <= 1024 characters

Responses

200

Default Response

Media typeapplication/json

Array<object>

object

id

required

string

jobId

required

string

sourceAddress

required

string

targetMailboxId

required

Any of:

string

string

null

null

targetAddress

required

Any of:

string

string

null

null

state

required

string

Allowed values: pending running done failed skipped

progress

required

object

foldersTotal

required

integer

<= 9007199254740991

foldersDone

required

integer

<= 9007199254740991

messagesTotal

required

integer

<= 9007199254740991

messagesDone

required

integer

<= 9007199254740991

messagesSkipped

required

integer

<= 9007199254740991

bytesDone

required

integer

<= 9007199254740991

errorCode

required

Any of:

string

string

Allowed values: auth connection tls quota rate_limited folder source_missing target_missing cancelled unknown

null

null

errorDetail

required

Any of:

string

string

null

null

lastRunAt

required

Any of:

string

string

null

null

hasSecret

required

boolean

Example

[
  {
    "state": "pending",
    "errorCode": "auth"
  }
]