API: Leads Creation
Table of Contents
Introduction
The API Leads Creation endpoint provides functionality to create leads, contacts and associate them with existing companies if email domains match. This API supports a variety of payload fields for various business needs.
Endpoints
Base URL
| Base URL |
| https://<server>:<port>/api/v1/contacts/leads |
Endpoint
Endpoint |
/leads |
| Method | POST |
| Name | Type | Required | Description |
| company_name | string | Yes | Name of the company for the lead. |
| first_name | string | Yes | First Name |
| last_name | string | No | Last Name |
| string | Yes | Email address of the lead | |
| phone | string | No | Phone number |
| website | string | No | Company website |
| partner_id | integer | No | If specified, contact is automatically created |
| mobile | string | No | Mobile number |
| street | string | No | Street address |
| street2 | string | No | Street2 |
| city | string | No | City |
| county | string | No | County Name |
| zip | string | No | Postal code |
| country | string | No | Country code (ISO) |
| opt_in_phone | boolean | No | Consent for phone communication |
| opt_in_email | boolean | No | Consent for email communication |
| opt_in_post | boolean | No | Consent for postal communication |
| source | string | Yes | Source of the lead (e.g., campaign) |
| industry | string | No | Industry related to the lead |
Request Example
|
{"leads": [
|
Successful Response Example
| { "created": [ { "first_name": "John", "res_addresses_id": false, "type": "lead", "email": "[email protected]", "last_name": "Smith", "partner_id": false, "create_date": "2024-12-05 15:25:39", "write_date": false, "id": 101002, "opt_in_email": true } ], "updated": [], "errors": {} } |