Leads

Add a lead

POST /v1/lead

Request

Field	Type	Description
firstName*	string	Max 50 characters.
lastName	string	Max 50 characters.
companyName*	string	Max 100 characters.
companyDba*	string	Max 100 characters.
phone	string	Max 30 characters.
email	string	Max 100 characters.
assignedTo	string[]	Persons to assign the lead to. Non-existent persons are ignored.
sourceCompany	string	Max 100 characters.

Response

Field	Type	Description
success	boolean
id	string	The unique identifier of the added lead.
invalidData	object	Present when some submitted data was rejected.

Example

result = client.leads.add(
    company_name="Acme Inc",
    company_dba="Acme",
    first_name="Jane",
    last_name="Doe",
    email="jane@acme.com",
)
print(result.id, result.success)

Example response

{ "success": true, "id": "12345" }