Skip to main content
POST
Add or update a lead

Authorizations

x-api-key
string
header
required

Your API key, from the API keys page of the app.

Path Parameters

uuid
string
required

The campaign's UUID.

Example:

"019f2504-58b8-77ec-9c3f-54f5d6df733e"

Body

application/json
email
string
required
Example:

"john.doe@example.com"

leadId
number

Id of an existing lead in this campaign to update. The lead keeps its id and history even when the email changes, and omitted names, company and profile fields are carried over from the lead. Without it the lead is matched by email.

Example:

42

firstName
string
Example:

"John"

lastName
string
Example:

"Doe"

companyName
string
Example:

"Acme Inc."

pauseUntil
string

Pause lead processing until this date

Example:

"2026-06-30T00:00:00.000Z"

variables
object[]
Example:

Response

Lead created successfully / Lead updated successfully

message
string
required

Lead created successfully, or Lead updated successfully.

Example:

"Lead created successfully"

data
object
required