API-Triggered Sequences
Enroll contacts into sequences programmatically using the API
Use API execution when you want external systems (CRM, booking tools, POS, Zapier flows) to enroll contacts into a sequence.
Available Endpoints
Public API v1
POST /api/v1/sequences/:id/execute
- Auth: API key
- Required scope:
sequences:execute - Body accepts contact objects (email-first payload)
- Limit: up to 100 contacts per request
App/Internal API
POST /api/sequences/:id/execute
- Auth: signed-in app session
- Body accepts existing
contactIds - Limit: up to 500 contacts per request
v1 Example
curl -X POST "https://your-domain.com/api/v1/sequences/SEQUENCE_ID/execute" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"contacts": [
{
"email": "customer@example.com",
"firstName": "Jane",
"lastName": "Doe",
"phone": "+15551234567"
}
]
}'
Execution Rules
Execution is blocked when:
- Sequence is not Active
- Sequence has no steps
- All submitted contacts are invalid/unsubscribed
A/B Behavior With API Execution
If A/B testing is enabled and configured, API enrollment can split traffic between Sequence A and Variant B based on your configured percentage.
For setup details, see A/B Testing Sequences.
Best Practices
- Start with 1-3 test contacts before bulk execution
- Ensure your sequence includes at least one deterministic first step
- Include monitoring around API errors and retry logic in your integration layer
- Keep contact identity consistent (same email/phone formatting)
// Related articles
Creating Your First Sequence
Build and activate an automated multi-step sequence for survey and follow-up workflows
Event-Based Automation
Automatically run sequences when specific response events occur
A/B Testing Sequences
Split sequence traffic between two variants and compare outcomes
Sequence Troubleshooting
Diagnose why sequences are not running or certain steps are skipped
Was this article helpful?
Let us know if you found this article helpful or if you need more information.
Join hundreds of businesses already using demeterrr to collect feedback, boost reviews, and grow faster.
Start Your Trial