Create lead
This endpoint is used to create new leads in COLMS Leads managemer for a specific organisation.
Reference - COLMS Create lead docs
Method and endpoint
POST /v1/lead
Headers
| Header name | Header value |
|---|---|
| Authorization | Basic base64(username:password) |
| Content-type | application-json |
Company
Within the body of the request message is a company field that requires the specification of the organisation the new lead is being created for.
| Company name | Field value |
|---|---|
| AfriForum | afriforum |
| AfriForum International | afriforum-international |
| FAK | fak |
| Voortrekker Monument | vtm |
| Kaapse Forum | kaapseforum |
| SAAI | Suider-Afrika Agri Inisiatief (SAAI) |
Body
Request schema
{
"company": "string",
"full_name": "string",
"surname": "string",
"id_type": "string",
"id_no": "string",
"cell_number": "string",
"campaign": "string",
"lead_source": "string",
"product_name": "string",
"business_name": "string",
"language": "string",
"age": 1,
"title": "string",
"initials": "string",
"gender": "string",
"marital_status": "string",
"branch": "string",
"physical_address": "string",
"physical_province": "string",
"physical_city": "string",
"physical_suburb": "string",
"physical_postal_code": "string",
"physical_country": "string",
"postal_address": "string",
"postal_province": "string",
"postal_suburb": "string",
"postal_city": "string",
"postal_postal_code": "string",
"postal_country": "string",
"additional_contact_numbers": [
"string",
"string"
],
"tel_work": "string",
"tel_home": "string",
"email": "string",
"category": "string",
"special_comments": "string"
}
{
"company": "Afriforum",
"full_name": "Test",
"surname": "One",
"id_type": "SA ID",
"id_no": "0010025123023",
"cell_number": "08365412530",
"campaign": "Marketing123",
"lead_source": "6142313",
"product_name": "Widget X",
"business_name": "ABC Business Solutions",
"language": "English",
"age": 30,
"title": "Mr",
"initials": "T",
"gender": "Male",
"marital_status": "Single",
"branch": "Main Branch",
"physical_address": "123 Main Street",
"physical_province": "Example Province",
"physical_city": "Example City",
"physical_suburb": "Suburbia",
"physical_postal_code": "12345",
"physical_country": "South Africa",
"postal_address": "P.O. Box 789",
"postal_province": "Example Province",
"postal_suburb": "Suburbia",
"postal_city": "Example City",
"postal_postal_code": "54321",
"postal_country": "South Africa",
"additional_contact_numbers": [
"0836541210",
"0836541220"
],
"tel_work": "0123456789",
"tel_home": "0836541230",
"email": "john.doe@example.com",
"category": "Customer",
"special_comments": "This customer prefers email communication."
}
Sample response
{
"result": true,
"lead_id": "000000000140702",
"message": "Lead received successfully"
}