Skip to content

Block Inbox Sender

POST
/inbox/blocked-senders

Stop a sender reaching ONE mailbox.

Scoped to the mailbox named in the body, not to the organisation: the same sender still reaches every other mailbox until blocked there too. This is an INGESTION filter - it is not a suppression, and it does not stop graph8 emailing them (see /contacts/suppressions for that).

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Stop a sender reaching one mailbox.

Scoped to the MAILBOX, not the organisation: blocking on one mailbox does not block the same sender on another.

object
mailbox
required

The mailbox to block them on.

string
reason
Any of:
string
sender_email
required

The address to block.

string

Responses

201

Successful Response

object
data
required

An open envelope for a comment, an assignment or a workspace.

Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string