Skip to main content
POST
cURL

Authorizations

API-Key
string
header
required

Account-scoped API key created in Settings. Operations declare the scopes they require. Available scopes:

  • RULES_READ: List and inspect automation rules for this inbox.
  • RULES_WRITE: Create, update, and delete automation rules for this inbox.
  • STATS_READ: Read aggregated inbox statistics for this inbox.

Body

application/json
name
string
required
Minimum string length: 1
condition
object
required
actions
object[]
required
Minimum array length: 1
runOnThreads
boolean
default:true

Response

Successful response

rule
object
required