Skip to main content

Endpoint

POST /backend/cadences

Body Parameters

name
string
required
Cadence name
description
string
Description
active
boolean
default:"true"
Whether cadence is active
steps
array
required
Cadence steps

Step Structure

steps[].order
integer
required
Step order (1, 2, 3…)
steps[].delay
string
required
Delay in ISO 8601 format (PT30M, P1D, etc.)
steps[].message
object
required
Message to send

Request Example

curl -X POST "https://api.leavo.ai/backend/cadences" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New Lead Welcome",
    "description": "Welcome sequence for new leads",
    "active": true,
    "steps": [
      {
        "order": 1,
        "delay": "PT0S",
        "message": {
          "type": "text",
          "content": "Hello {{LEAD_FIRSTNAME}}! Welcome to our platform. How can I help you?"
        }
      },
      {
        "order": 2,
        "delay": "P1D",
        "message": {
          "type": "text",
          "content": "Hi {{LEAD_FIRSTNAME}}, I noticed you haven'\''t replied yet. Do you have any questions?"
        }
      },
      {
        "order": 3,
        "delay": "P3D",
        "message": {
          "type": "text",
          "content": "{{LEAD_FIRSTNAME}}, I'\''m here if you need anything. Just reply to this message!"
        }
      }
    ]
  }'

Response

{
  "success": true,
  "data": {
    "id": "cadence-uuid",
    "name": "New Lead Welcome",
    "description": "Welcome sequence for new leads",
    "active": true,
    "steps": [...],
    "created_at": "2024-01-15T10:30:00Z"
  }
}