Skip to content

Cadences API

11 endpoints. All requests need an Authorization header — see Authentication. API keys additionally need the matching scope.

Method Path Description
GET /api/cadences List Cadences Query: status.
POST /api/cadences Create Cadence Accepts a JSON body.
GET /api/cadences/{cadence_id} Get Cadence
PATCH /api/cadences/{cadence_id} Update Cadence Accepts a JSON body.
DELETE /api/cadences/{cadence_id} Delete Cadence
GET /api/cadences/{cadence_id}/analytics Cadence Analytics
POST /api/cadences/{cadence_id}/enroll Enroll Batch Accepts a JSON body.
GET /api/cadences/{cadence_id}/enrollments List Enrollments Query: status, limit, offset.
POST /api/cadences/{cadence_id}/steps Add Step Accepts a JSON body.
PATCH /api/cadences/{cadence_id}/steps/{step_id} Update Step Accepts a JSON body.
DELETE /api/cadences/{cadence_id}/steps/{step_id} Delete Step

Try it

The full request/response schema for every endpoint is in the OpenAPI spec served by your own workspace.