Skip to main content
POST
Create a mailbox filter

Authorizations

Authorization
string
header
required

Your Inbound API key. Include it in the Authorization header as: Bearer

Path Parameters

id
string
required

Body

name
string
required
Required string length: 1 - 255
conditions
object[]
required
Required array length: 1 - 20 elements
actions
object[]
required
Required array length: 1 - 20 elements
enabled
boolean

Default true

match
enum<string>
Available options:
all,
any
stopProcessing
boolean

Skip later filters when this one matches. Default false.

Response

Response for status 201

id
string
required
name
string
required
position
number
required
enabled
boolean
required
match
enum<string>
required
Available options:
all,
any
conditions
object[]
required
actions
object[]
required
stopProcessing
boolean
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required