Bring people back
Brings back people who were taken out of the campaign and never got an email, chosen by ids, addresses, tag, a file (CSV text of ids or addresses) or all_removed: true. Send preview: true first to see how many would come back. People who were emailed, replied, bounced, unsubscribed or are blocked never come back. The ones who come back wait for the first email; nothing is sent until the campaign runs. 2,000 people or more come back in the background: the answer is 202 with a job to follow at its status_url (kind restore).
| Cost | What it does | Key scopes |
|---|---|---|
| Free | Writes | 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
application/json
curl -X POST "https://app.argorant.com/api/v1/campaigns/7f3a2c1e-9b4d-4e8a-a1c2-5d6e7f8a9b0c/leads/restore" \ -H "Idempotency-Key: 6f1c2e7a-run-42" \ -H "Content-Type: application/json" \ -d '{ "tag": "q4", "preview": true }'{ "matched": 420, "would_restore": 400, "kept_out_contacted": 20, "preview": true, "restored": 0, "summary": "400 people who were taken out would come back into the campaign. 20 stay out because they were already emailed, replied or bounced. Nothing was changed yet."}