POST
/
leads
/
initialize
curl --location --request POST 'https://api.upmarket.ai/leads/initialize' \
--header 'Content-Type: application/json' \
--header 'x-upmarket-key: xxxxxxxxxxxxxxxxxxx' \
--data-raw '{
    "client_lead_id": "",
    "journey_id": "",
    "lead_type": "",
    "lead_name": ""
}'

data: "lead_id"
x-upmarket-key
default: "xxxxxxxxxxxxxxxxxxx"required

This is the API Key you generated from Upmarket.

​
Body

client_lead_id
string
required

client_lead_id is the unique identifier for a lead in the source system. This can be a user’s uid or a customer’s customerId.

journey_id
string
required

journey_id of the Upmarket journey the lead is associated with.

lead_type
string
required

lead_type the type of lead, either ‘account’ or ‘contact’

lead_name
string
required

lead_name the name of the lead

​
Response

lead_id
string

A successful request will return a lead_id