Send a test email
Sends one test of a campaign email to you or to a member of your workspace, filled with a sample contact. Adds nobody to the campaign and changes nothing. A few tests an hour per account.
| Cost | What it does | Key scopes |
|---|---|---|
| Free | Sends email | argorant:manage_lists |
Authorization
BearerAuth Your API key from app.argorant.com/profile, sent as Authorization: Bearer <key>. A connector sign-in token (ag_mcp_...) works the same way.
In: header
Path Parameters
The campaign id from create or list.
uuidHeader Parameters
Any unique text up to 128 characters. A retry with the same key and the same body within 24 hours returns the first answer (with the header Idempotent-Replayed: true) instead of doing the work twice. The same key with another body answers 409 idempotency_conflict.
length <= 128Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.
^[A-Za-z0-9._-]{8,64}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://app.argorant.com/api/v1/campaigns/7f3a2c1e-9b4d-4e8a-a1c2-5d6e7f8a9b0c/test-email" \ -H "Idempotency-Key: 6f1c2e7a-run-42" \ -H "Content-Type: application/json" \ -d '{ "step": 1 }'{ "sent": true, "sent_from": "elena@northgate-advisory.com", "to": "you@northgate-advisory.com", "email": 1, "subject": "Quick question, Jane", "summary": "Sent a test of email 1 from elena@northgate-advisory.com to you@northgate-advisory.com. Nothing was added to the campaign and nothing else was sent."}