Quickstart with curl

Replace BASE and KEY as needed.

BASE=https://api.notiq.io/public/v1
KEY=sk_live_your_key_here

All requests need X-API-Key. Responses include X-Request-Id.

Credits

curl -sS "$BASE/credits" -H "X-API-Key: $KEY"

Launch Maps campaign

curl -sS -X POST "$BASE/campaigns" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{"userQuery":"dentists in Austin TX","numberOfSearch":25}'

Add lead by email

curl -sS -X POST "$BASE/campaigns/YOUR_CAMPAIGN_ID/leads" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-1" \
  -d '{"email":"jane@acme.com","fullName":"Jane Doe"}'

Batch add leads

curl -sS -X POST "$BASE/campaigns/YOUR_CAMPAIGN_ID/leads/batch" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-batch-1" \
  -d '{"leads":[{"email":"jane@acme.com","fullName":"Jane Doe"}]}'

Last replies

curl -sS "$BASE/activity?type=reply_received&limit=10" -H "X-API-Key: $KEY"

Insights overview

curl -sS "$BASE/insights/overview" -H "X-API-Key: $KEY"

List excluded leads

curl -sS "$BASE/campaigns/YOUR_CAMPAIGN_ID/leads?excluded=true&limit=5" \
  -H "X-API-Key: $KEY"

Batch update (tag / exclude)

curl -sS -X POST "$BASE/campaigns/YOUR_CAMPAIGN_ID/leads/batch-update" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-batch-update-1" \
  -d '{"updates":[{"leadId":"lead_1","excluded":true},{"leadId":"lead_2","tag":"Interested"}]}'

Batch delete (irreversible)

curl -sS -X POST "$BASE/campaigns/YOUR_CAMPAIGN_ID/leads/batch-delete" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-batch-delete-1" \
  -d '{"leadIds":["lead_1","lead_2"]}'

Start outreach

curl -sS -X POST "$BASE/campaigns/YOUR_CAMPAIGN_ID/start" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{"templateId":"tmpl_abc"}'

Error shape

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key.",
    "details": {}
  }
}

See Errors for codes, Endpoints for full contracts, and Quickstart for the guided path.