Enroll a lead in this cadence

POSThttps://myagentmail.com/cadences/{id}/enrollments

Idempotent on (cadenceId, leadExternalId) — re-enrolling the same lead returns the existing enrollment with created: false.

Lead identity fields: pass whatever you have. The runner uses leadLinkedinUrl for LinkedIn invites and leadEmail for email steps. leadProfileUrn is set automatically when the first LinkedIn invite is sent (the runner persists it for future after_accept attribution and reply-detection).

Path parameters

id

required

string

Request body

Content-Type: application/json

`leadExternalId` required string	Your stable id for the lead. Idempotency key.
`leadName` string
`leadEmail` string	format: email
`leadLinkedinUrl` string	format: uri
`leadProfileUrn` string
`sessionId` string	Required if cadence has any LinkedIn step.
`inboxId` string	Required if cadence has any email step. format: uuid
`context` object
`startAt` string	format: date-time

Responses

200Enrollment ready. `created` distinguishes new from existing.

Authentication

Send your API key in the X-API-Key header (or Authorization: Bearer <key>). Any prefix accepted by this endpoint — tk_, wk_, ak_, or sa_ — is documented in the key prefix table.

Request

import { MyAgentMail } from "myagentmail";

const client = new MyAgentMail({ apiKey: process.env.MYAGENTMAIL_API_KEY! });

// POST /cadences/{id}/enrollments
const result = await client.request("post", "/cadences/{id}/enrollments", { params: { id: "00000000-0000-0000-0000-000000000000" } }, { body: {
  "leadExternalId": "string",
  "leadName": "string",
  "leadEmail": "[email protected]",
  "leadLinkedinUrl": "https://example.com",
  "leadProfileUrn": "string",
  "sessionId": "string",
  "inboxId": "00000000-0000-0000-0000-000000000000",
  "context": {},
  "startAt": "2026-05-01T09:03:23.068Z"
} });