Skip to main content
POST
Bulk create / merge leads

Authorizations

Authorization
string
header
required

Admin-issued Personal Access Token, e.g. Authorization: Bearer mega_<64 hex>. The key carries scopes (public_api:leads:read, public_api:leads:write, public_api:webhooks:manage) and is locked to one customer.

Headers

x-customer-id
string<uuid>
required

The customer this request acts on. Must match the customer your key is locked to.

Idempotency-Key
string

Client-generated unique key. Replaying the same key returns the original stored response instead of creating duplicates. Scoped per customer + endpoint; reuse with a different body returns 409.

Body

application/json
leads
object[]
required
Required array length: 1 - 500 elements
on_duplicate
enum<string>
default:update
Available options:
update,
skip
dry_run
boolean
default:false

Response

Per-row import results + summary.

dry_run
boolean
required
summary
object
required
results
object[]
required
unknown_custom_fields
string[]
required

Custom-field slugs that did not match any definition and were ignored.