Skip to Content

The BatchUnjunkEntry type of the TypeScript SDK, part of BatchUnjunkResult.

type BatchUnjunkEntry = {
  id: string
  message?: MessageMeta
  status: ('unjunked' | 'not_junked' | 'not_found')
}

Fields

FieldTypeDescription
idstringMessage ULID
messageMessageMetaOptional. Unjunked message metadata (when status=unjunked)
status('unjunked' | 'not_junked' | 'not_found')Unjunk outcome for this message. not_junked: the message exists and is readable but does not carry the Junk label, so there is nothing to undo — deliberately distinct from not_found, which means no such live message (an EXPUNGED id is not_found here; use POST /messages/restore for that tier).

Used in

BatchUnjunkResult.

On this page