Personal lines from a file

Server URLloading...

POST

/api/v1/campaigns/{campaign_id}/leads/custom-fields/import

Send

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.

Authorization (Header)string

Path

campaign_id*string

Header

Idempotency-Keystring

X-Request-Idstring

Query

overwritebooleanUnset

Body

leadsarray, JSON[ { "email": "jane.doe@example-acme.com", "values": { "custom_opener": "Congrats on the new Munich office." } } ]

The people with their lines, when you send JSON. CSV and NDJSON go as the raw body instead.

overwriteboolean

Not sent

 Not senttruefalse

In a JSON object, the same as the query parameter.

Send a finished file of personal lines in one go: CSV (header email or lead_id, then one column per {{custom_...}} variable, optional basis, keep_fallback and clear), JSON ([{email or lead_id, values: {...}}] or {"leads": [...], "overwrite": true}) or NDJSON, up to 200,000 rows and 50 MB. Send the file as the body with Content-Type text/csv, application/json or application/x-ndjson, or as multipart form data in a file field. Every row gets the same checks as a single call. Rows that fail are listed by row number and never stop the rest. Up to 5,000 rows are written at once; a bigger file answers with a job to follow. Up to 30 files an hour per workspace.

A line a person already has is kept unless you send overwrite=true (query parameter, a form field, or overwrite in the JSON object). Kept lines are listed in kept_existing with their row. With overwrite, replaced lines are counted in changed and kept as a record, old and new. To clear lines with overwrite, name the variables in the CSV clear column (several separated by spaces, or all), or send them as null in JSON. An empty CSV cell never clears anything. The same file with and without overwrite are two separate uploads.

Path Parameters

Query Parameters

Header Parameters

Response Body

curl -X POST "https://app.argorant.com/api/v1/campaigns/7f3a2c1e-9b4d-4e8a-a1c2-5d6e7f8a9b0c/leads/custom-fields/import" \  -H "Idempotency-Key: 6f1c2e7a-run-42" \  -H "Content-Type: application/json" \  -d '{    "leads": [      {        "email": "jane.doe@example-acme.com",        "values": {          "custom_opener": "Congrats on the new Munich office."        }      }    ]  }'

{  "format": "json",  "total_rows": 1,  "valid_rows": 1,  "invalid_count": 0,  "invalid": [],  "status": "done",  "overwrite": false,  "written": 1,  "kept_fallback": 0,  "unchanged": 0,  "duplicates": 0,  "changed": 0,  "cleared": 0,  "kept_existing_count": 0,  "kept_existing": [],  "not_found_count": 0,  "not_found": [],  "summary": "Saved lines for 1 contact."}