Update a message

PATCHhttps://anjal.app/v1/inboxes/{id}/messages/{messageId}

Change labels (replace with labels, or change with addLabels / removeLabels) and state (read, starred, archived, spam). Returns the message's labels after the change.

Path parameters

`id` required string	Inbox UUID
`messageId` required string	Message UUID

Request body

Content-Type: application/json

`labels` string[] \| string	Labels as an array or a comma-separated string. Stored lowercase and deduplicated; at most 32 labels of at most 64 characters, no commas.
`addLabels` string[] \| string	Labels as an array or a comma-separated string. Stored lowercase and deduplicated; at most 32 labels of at most 64 characters, no commas.
`removeLabels` string[] \| string	Labels as an array or a comma-separated string. Stored lowercase and deduplicated; at most 32 labels of at most 64 characters, no commas.
`isRead` boolean
`isStarred` boolean
`isArchived` boolean
`isSpam` boolean	true moves it to Spam; false recovers it.

Responses

200application/jsonUpdated

`updated` boolean
`id` string
`labels` string[]
`isRead` boolean
`isStarred` boolean
`isArchived` boolean
`isSpam` boolean

400application/jsonRequest body failed schema validation

`error` required string
`code` string

404application/jsonResource not found

`error` required string
`code` string

Authentication

Send your API key in the X-API-Key header (or Authorization: Bearer <key>). Any prefix accepted by this endpoint — tk_, wk_, ak_, or sa_ — is documented in the key prefix table.

Request

import { Anjal } from "anjal";

const client = new Anjal({ apiKey: process.env.MYAGENTMAIL_API_KEY! });

// PATCH /v1/inboxes/{id}/messages/{messageId}
const result = await client.request("patch", "/v1/inboxes/{id}/messages/{messageId}", { params: { id: "00000000-0000-0000-0000-000000000000", messageId: "00000000-0000-0000-0000-000000000000" } }, { body: {
  "labels": [
    "needs-review",
    "q4-campaign"
  ],
  "addLabels": [
    "needs-review",
    "q4-campaign"
  ],
  "removeLabels": [
    "needs-review",
    "q4-campaign"
  ],
  "isRead": false,
  "isStarred": false,
  "isArchived": false,
  "isSpam": false
} });

Example response · 200

{
  "updated": false,
  "id": "string",
  "labels": [
    "string"
  ],
  "isRead": false,
  "isStarred": false,
  "isArchived": false,
  "isSpam": false
}