Pause / resume / unenroll a lead

PATCHhttps://myagentmail.com/enrollments/{id}

Path parameters

id

required

string

Request body

Content-Type: application/json

`state` "active" \| "paused" \| "unenrolled"	enum: "active" \| "paused" \| "unenrolled"
`exitReason` string

Responses

200Updated.

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! });

// PATCH /enrollments/{id}
const result = await client.request("patch", "/enrollments/{id}", { params: { id: "00000000-0000-0000-0000-000000000000" } }, { body: {
  "state": "active",
  "exitReason": "string"
} });