Skip to main content
POST
Create lead

Authorizations

Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Body

application/json
phone_number
string
required
Example:

"+972501234567"

name
string | null
email
string<email> | null
tags
string[]

Tag names to attach. Resolved to IDs server-side. Use tag_ids to pass UUIDs directly.

tag_ids
string<uuid>[]

Tag IDs to attach. Use tags (names) or tag_ids (UUIDs), not both.

metadata
object

Response

Lead created

id
string<uuid>
phone_number
string
Example:

"+972501234567"

name
string | null
email
string<email> | null
source
string

How the lead was created: 'api', 'manual', or 'auto' (from inbound call).

Example:

"api"

tags
object[]
long_term_context
string | null

AI memory for this lead. Injected into the agent's system prompt at call time when lead_memory_enabled is true on the agent.

metadata
object
created_at
string<date-time>
updated_at
string<date-time>