Skip to main content
POST
/
api
/
e2
/
guard
Create guard rule
curl --request POST \
  --url https://inbound.new/api/e2/guard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "explicit",
  "config": "<unknown>",
  "description": "<string>",
  "priority": 123,
  "action": "<unknown>"
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "userId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "type": "<string>",
    "config": "<string>",
    "isActive": true,
    "priority": 123,
    "lastTriggeredAt": "<string>",
    "triggerCount": 123,
    "actions": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

Body

name
string
required

Rule name

Minimum string length: 1
type
enum<string>
required
Available options:
explicit,
ai_prompt
config
any
required

Rule configuration (JSON)

description
string

Rule description

priority
number

Rule priority (higher = evaluated first)

action
any

Rule action configuration

Response

Response for status 201

success
boolean
required
data
object
required