Message

Update message

Update message information. Mainly this means changing message flag values<br/><br/>For Gmail API accounts the entire label set cannot be replaced in one call. Add and remove labels individually instead of using the set operation.

put/v1/account/{account}/message/{message}

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/account/{account}/message/{message}
  • Auth: HTTP bearer

Path parameters

accountstring required

Unique identifier for the email account

Example:user123
messagestring required

Message ID

Example:AAAAAQAACnA

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Request body

Example request

{
  "flags": {
    "add": "\\Seen",
    "delete": "\\Flagged"
  }
}

Response

Returns which flag and label changes were applied.

Example response

{
  "flags": {
    "add": [
      "\\Seen"
    ],
    "delete": [
      "\\Seen"
    ],
    "set": [
      "\\Seen"
    ],
    "result": [
      "\\Seen"
    ]
  },
  "labels": {
    "add": [
      "Label_971539351003152516"
    ],
    "delete": [
      "Label_971539351003152516"
    ],
    "set": [
      "Label_971539351003152516"
    ],
    "result": [
      "Label1"
    ]
  }
}

Changes

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