INinkbox
Messages

Update Message Flags

Changed on
patch/api/v1/mail/mailboxes/{email_address}/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/mailboxes/{email_address}/messages/{message_id}
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

Path parameters

message_idstring uuid required
email_addressstring required

Request body

is_readboolean nullable
is_starredboolean nullable

Response

Successful Response

idstring uuid required
mailbox_idstring uuid required
thread_idstring uuid nullable required
message_idstring nullable
from_addressstring required
from_display_namestring nullable
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
reply_tostring nullable
first_opened_atstring date-time nullable
open_countinteger
created_atstring date-time required
updated_atstring date-time nullable
sending_domain_warningstring nullable
import_job_idstring uuid nullable

Changes