Add people
Adds a saved list (list_id) or your own rows. Every address is checked before it joins. When a source holds anything besides confirmed addresses and you did not say which to take, the answer is needs_choice with the count per result and adds nothing yet: ask the user, then call again with grades: ["valid"] (recommended) or ["valid", "catch_all"]. Invalid addresses never join. People from Argorant's data cost 1 credit each the first time; your own rows, repeats and people you already unlocked are free. Any extra key on a row, such as plan or city, becomes a variable like {{plan}}.
| Cost | What it does | Key scopes |
|---|---|---|
| 1 credit per new person from Argorant's data; your own rows, repeats and already unlocked people are free | Spends credits | argorant:manage_lists |
Request
- Base URL: https://app.argorant.com
- URL: https://app.argorant.com/api/v1/campaigns/{campaign_id}/leads
- Auth: HTTP bearer
Path parameters
The campaign id from create or list.
Headers
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.
Your 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.
Request body
Example request
{
"list_id": 312
}Response
Asks first or OK
Changes
No recorded changes to this operation across all 1 revision of this API.