Move multiple messages

POST/accounts/{account_id}/email-security/investigate/move

Maximum batch size: 1000 messages per request

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Cloud Email Security: Write

Path ParametersExpand Collapse

account_id: string

Account Identifier

maxLength32

minLength32

Body ParametersJSONExpand Collapse

destination: "Inbox" or "JunkEmail" or "DeletedItems" or 2 more

One of the following:

"Inbox"

"JunkEmail"

"DeletedItems"

"RecoverableItemsDeletions"

"RecoverableItemsPurges"

ids: optional array of string

List of message IDs to move.

Deprecatedpostfix_ids: optional array of string

Deprecated: Use ids instead. List of message IDs to move.

ReturnsExpand Collapse

errors: array of ResponseInfo { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional { pointer }

pointer: optional string

messages: array of ResponseInfo { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional { pointer }

pointer: optional string

result: array of { completed_timestamp, item_count, success, 6 more }

Deprecatedcompleted_timestamp: string

Deprecated, use completed_at instead

formatdate-time

Deprecateditem_count: number

formatint32

success: boolean

completed_at: optional string

formatdate-time

destination: optional string

message_id: optional string

operation: optional string

recipient: optional string

status: optional string

success: boolean

Move multiple messages

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/email-security/investigate/move \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
          "destination": "Inbox"
        }'

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "completed_timestamp": "2019-12-27T18:11:19.117Z",
      "item_count": 0,
      "success": true,
      "completed_at": "2019-12-27T18:11:19.117Z",
      "destination": "destination",
      "message_id": "message_id",
      "operation": "operation",
      "recipient": "recipient",
      "status": "status"
    }
  ],
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "completed_timestamp": "2019-12-27T18:11:19.117Z",
      "item_count": 0,
      "success": true,
      "completed_at": "2019-12-27T18:11:19.117Z",
      "destination": "destination",
      "message_id": "message_id",
      "operation": "operation",
      "recipient": "recipient",
      "status": "status"
    }
  ],
  "success": true
}