Create a lead for a company
POST
/api/v1/companies/{company_id}/leads
Request
Path Params
Header Params
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/companies//leads' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
"lead": {
"full_name": "string",
"zip_code": "string",
"campaign_name": "string",
"ad_name": "string",
"platform": "string",
"creation_source": "manual",
"lead_date": "string",
"email": "user@example.com",
"phone_number": "string",
"user_lead": {
"user_id": 0,
"status": "string",
"ranked_lead": true,
"lead_average": 0
}
}
}'Response Response Example
201 - Example 1
{
"lead": {
"id": 0,
"full_name": "string",
"zip_code": "string",
"campaign_name": "string",
"ad_name": "string",
"platform": "string",
"creation_source": "string",
"confirmation_phone": "string",
"is_valid_zip_code": true,
"secondary_phone_valid": true,
"lead_date": "string",
"has_lead_notes": true,
"participant": {
"id": 0,
"token": "string",
"email": "string",
"phone_number": "string",
"first_application_at": "string",
"last_application_at": "string",
"primary_phone_valid": true
},
"assigned_to": {
"id": 0,
"status": "string",
"assigned_at": "string",
"user": {
"id": 0,
"name": "string",
"avatar_url": "string"
}
},
"lead_answers": [
{
"id": 0,
"value": "string",
"question": {
"question_label": "string",
"question_text": "string"
}
}
],
"stage": {
"id": 0,
"label": "string",
"hex_color": "string",
"stage_type": "string",
"label_translate": {},
"priority": 0,
"icon_type": "string",
"icon_color": "string"
},
"address": {
"id": 0,
"value": "string",
"latitude": 0,
"longitude": 0,
"coordinates": {},
"address_comments": "string",
"is_valid_address": true
}
}
}Modified at 2026-03-23 15:30:28