Skip to main content
POST
Create lead
Create a new lead in your organization. Use Cases:
  • Partner systems creating leads from external sources
  • CRM integrations syncing leads into Aura
  • Manual lead entry from external applications
Required fields:
  • email - Must be a valid email address
Optional fields:
  • full_name, phone, company, timezone, visitor_id, metadata
New leads are created with status “new” by default.

Body

application/json
email
string<email>
required

Email address (required)

Example:

"john@example.com"

company
string

Company name

Example:

"Acme Corp"

full_name
string

Full name of the lead

Example:

"John Doe"

metadata
object | null

Lead attribution metadata. See the LeadMetadata schema for documented camelCase keys (utmSource, fbclid, etc.). Unknown keys are accepted for forward compatibility but only the documented fields are part of the stable contract. Pass null or omit to skip.

phone
string

Phone number in E.164 format (validated): + followed by country code and digits, no spaces or hyphens.

Pattern: ^\+[1-9]\d{1,14}$
Example:

"+14155552671"

timezone
string

Lead's timezone. Must be an IANA zone (e.g. Europe/Berlin); the common aliases EST, CET, PST8PDT and US/Pacific are accepted, and surrounding whitespace is trimmed. Anything else is DISCARDED rather than rejected: the request still succeeds and every other field is applied. On create the timezone is left empty; on update the lead's existing timezone is left UNCHANGED, never cleared. If an unusable timezone is the only field supplied to an update, the request is rejected, because nothing would have been applied. Rejecting outright at the boundary is planned once telemetry shows nobody depends on the current leniency (AUR-2090).

Example:

"America/New_York"

visitor_id
string

Anonymous first-party visitor identifier used to attach the pre-lead funnel journey.

Required string length: 8 - 128
Example:

"voics_550e8400-e29b-41d4-a716-446655440000"

Response

Successfully created lead

data
object
required
success
enum<boolean>
required
Available options:
true