INinkbox
Messages

Get Message By Visibility

Changed on
get/api/v1/mail/messages/{message_id}

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/mail/messages/{message_id}
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

Path parameters

message_idstring uuid required

Query parameters

max_body_charsinteger

Response

Successful Response

idstring uuid required
mailbox_idstring uuid required
thread_idstring uuid nullable required
message_idstring nullable required
from_addressstring required
from_display_namestring nullable
sender_contact_namestring nullable
reply_tostring nullable required
to_addressesstring[] required
cc_addressesstring[] nullable required
subjectstring nullable required
snippetstring nullable required
direction'inbound' | 'outbound' required
status'queued' | 'sent' | 'delivered' | 'bounced' | 'failed' | 'received' | 'deleted' required
is_readboolean required
is_starredboolean required
has_attachmentsboolean required
created_atstring date-time required
updated_atstring date-time required
body_textstring nullable required
body_htmlstring nullable required
body_truncatedboolean required
bcc_addressesstring[] nullable required
in_reply_tostring nullable required
referencesstring[] nullable required

Changes

  • f3dcdb50fbaaRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status