Inboxes

Label a message

Add and/or remove your own labels (a-z, 0-9, _ : . -). System labels can't be set or removed.

patch/v1/inboxes/{inboxId}/messages/{emailId}

Request

  • Base URL: https://api.volanea.com
  • URL: https://api.volanea.com/v1/inboxes/{inboxId}/messages/{emailId}
  • Auth: HTTP bearer

Path parameters

inboxIdstring required

Inbox id.

emailIdstring required

Message id.

Request body

addLabelsstring[]
removeLabelsstring[]

Response

Updated.

emailIdstring required
inboxIdstring required
threadIdstring required
direction'inbound' | 'outbound' required
fromstring required
fromNamestring nullable
tostring required
ccstring[]
subjectstring required
textstring nullable

Plain-text part of received mail. Null on sent mail.

extractedTextstring nullable

text without quoted history and signature — the new part of a reply.

bccstring[]

Sent mail only.

inReplyToEmailIdstring nullable

The campaign/workflow/transactional email this answers, when it answers one.

campaignIdstring nullable
htmlstring nullable

Only on single-message and thread reads. Received HTML is sanitized: no scripts, iframes, or event handlers.

labelsstring[] required

System: spam, virus (attachments not downloadable), unauthenticated (neither SPF nor DKIM passed), held, security-review. Plus any you set.

plusTagstring nullable

order42 for mail sent to name+order42@….

statusstring
createdAtstring date-time required
sentAtstring date-time nullable

Changes

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