Leads

Create lead

Create a new lead.

You can assigned the lead with an existing partner using the partnerId property. You will be the source of the lead and the partner will have to accept or refuse the lead.

You can set the source of the lead using the sourcePartnerId property. By doing that, you create the lead on behalf of the partner. He won’t have to accept or refuse the lead, the lead will be automatically accepted.

Use the note property to add a new note on create lead.

If the lead comes from your website via a referral link shared by a partner and you want to associate it with the correct partner, use the HTTP header:
Kiflo-Tracking-Code: AABBCCDDEEFF+=

The** tracking code** can be retrieved in javascript from your website using the JS SDK.Please referer to theJS SDK documentation.

The status property is optional and can be used only in conjunction with the header parameter Kiflo-Tracking-Code. It can be one of the following value:

Pending: the lead is assigned to the source partner and must be validated by you
Accepted: the lead is assigned to the source partner and is automatically accepted
Unassigned: the lead is not assigned to any partner, but the source partner is set correctly. it can be shared to another partner manually

POST

leads

Create lead

curl --request POST \
  --url https://api.example.com/v3/leads \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "properties": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@doe.com",
    "project_amount": 20000
  },
  "currency": "USD",
  "ownerUserId": null,
  "partnerId": 42,
  "sourcePartnerId": 42,
  "userPartnerOwnerId": null,
  "assignedContactEmail": null,
  "deadLine": "2020-07-14T00:00:00",
  "note": "Very hot lead!",
  "status": null,
  "assignToPartnerOwner": null
}
'

import requests

url = "https://api.example.com/v3/leads"

payload = {
    "properties": {
        "firstName": "John",
        "lastName": "Doe",
        "email": "john@doe.com",
        "project_amount": 20000
    },
    "currency": "USD",
    "ownerUserId": None,
    "partnerId": 42,
    "sourcePartnerId": 42,
    "userPartnerOwnerId": None,
    "assignedContactEmail": None,
    "deadLine": "2020-07-14T00:00:00",
    "note": "Very hot lead!",
    "status": None,
    "assignToPartnerOwner": None
}
headers = {"Content-Type": "application/json-patch+json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    properties: {
      firstName: 'John',
      lastName: 'Doe',
      email: 'john@doe.com',
      project_amount: 20000
    },
    currency: 'USD',
    ownerUserId: null,
    partnerId: 42,
    sourcePartnerId: 42,
    userPartnerOwnerId: null,
    assignedContactEmail: null,
    deadLine: '2020-07-14T00:00:00',
    note: 'Very hot lead!',
    status: null,
    assignToPartnerOwner: null
  })
};

fetch('https://api.example.com/v3/leads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v3/leads",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'properties' => [
        'firstName' => 'John',
        'lastName' => 'Doe',
        'email' => 'john@doe.com',
        'project_amount' => 20000
    ],
    'currency' => 'USD',
    'ownerUserId' => null,
    'partnerId' => 42,
    'sourcePartnerId' => 42,
    'userPartnerOwnerId' => null,
    'assignedContactEmail' => null,
    'deadLine' => '2020-07-14T00:00:00',
    'note' => 'Very hot lead!',
    'status' => null,
    'assignToPartnerOwner' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v3/leads"

	payload := strings.NewReader("{\n  \"properties\": {\n    \"firstName\": \"John\",\n    \"lastName\": \"Doe\",\n    \"email\": \"john@doe.com\",\n    \"project_amount\": 20000\n  },\n  \"currency\": \"USD\",\n  \"ownerUserId\": null,\n  \"partnerId\": 42,\n  \"sourcePartnerId\": 42,\n  \"userPartnerOwnerId\": null,\n  \"assignedContactEmail\": null,\n  \"deadLine\": \"2020-07-14T00:00:00\",\n  \"note\": \"Very hot lead!\",\n  \"status\": null,\n  \"assignToPartnerOwner\": null\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v3/leads")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"properties\": {\n    \"firstName\": \"John\",\n    \"lastName\": \"Doe\",\n    \"email\": \"john@doe.com\",\n    \"project_amount\": 20000\n  },\n  \"currency\": \"USD\",\n  \"ownerUserId\": null,\n  \"partnerId\": 42,\n  \"sourcePartnerId\": 42,\n  \"userPartnerOwnerId\": null,\n  \"assignedContactEmail\": null,\n  \"deadLine\": \"2020-07-14T00:00:00\",\n  \"note\": \"Very hot lead!\",\n  \"status\": null,\n  \"assignToPartnerOwner\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/leads")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"properties\": {\n    \"firstName\": \"John\",\n    \"lastName\": \"Doe\",\n    \"email\": \"john@doe.com\",\n    \"project_amount\": 20000\n  },\n  \"currency\": \"USD\",\n  \"ownerUserId\": null,\n  \"partnerId\": 42,\n  \"sourcePartnerId\": 42,\n  \"userPartnerOwnerId\": null,\n  \"assignedContactEmail\": null,\n  \"deadLine\": \"2020-07-14T00:00:00\",\n  \"note\": \"Very hot lead!\",\n  \"status\": null,\n  \"assignToPartnerOwner\": null\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "creationDate": "2023-11-07T05:31:56Z",
  "properties": {},
  "partnerId": 123,
  "sourcePartnerId": 123,
  "userPartnerOwnerId": 123,
  "dealId": 123,
  "customerId": 123,
  "deadLine": "2023-11-07T05:31:56Z",
  "assignedDate": "2023-11-07T05:31:56Z",
  "acceptedDate": "2023-11-07T05:31:56Z",
  "refusedDate": "2023-11-07T05:31:56Z",
  "convertedDate": "2023-11-07T05:31:56Z",
  "abandonedDate": "2023-11-07T05:31:56Z",
  "status": "Unknown",
  "partnerName": "<string>",
  "dealName": "<string>",
  "customerName": "<string>",
  "source": "Unknown",
  "transferredLeadId": 123,
  "currency": "<string>",
  "ownerUserId": 123,
  "owner": {
    "id": 123,
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  }
}

Body

properties

object | null

Show child attributes

currency

string | null

ownerUserId

integer<int32> | null

partnerId

integer<int32> | null

The partner to whom the lead is assigned.

sourcePartnerId

integer<int32> | null

The partner to who declared the lead.

userPartnerOwnerId

integer<int32> | null

The user partner assigned to the lead.

assignedContactEmail

string | null

The email of the user partner assigned to the lead. PartnerId must be specified.

deadLine

string<date-time> | null

note

string | null

Optional note to add to the lead after its creation.

status

enum<string>

Available options:

Unknown,

Unassigned,

Pending,

Accepted,

Refused,

Reassigned,

Converted,

Abandoned

assignToPartnerOwner

boolean | null

If true, the Lead OwnerUserId will be the same as the Partner OwnerUserId

Response

Lead created

integer<int32>

creationDate

string<date-time>

properties

object | null

Show child attributes

partnerId

integer<int32> | null

sourcePartnerId

integer<int32> | null

userPartnerOwnerId

integer<int32> | null

dealId

integer<int32> | null

customerId

integer<int32> | null

deadLine

string<date-time> | null

assignedDate

string<date-time> | null

acceptedDate

string<date-time> | null

refusedDate

string<date-time> | null

convertedDate

string<date-time> | null

abandonedDate

string<date-time> | null

status

enum<string>

Available options:

Unknown,

Unassigned,

Pending,

Accepted,

Refused,

Reassigned,

Converted,

Abandoned

partnerName

string | null

dealName

string | null

customerName

string | null

source

enum<string>

Available options:

Unknown,

Website,

Partner,

Api,

Zapier,

Tenant,

System,

HubSpot,

Stripe,

PartnerDirectory

transferredLeadId

integer<int32> | null

currency

string | null

ownerUserId

integer<int32> | null

owner

object

Show child attributes

Create lead

curl --request POST \
  --url https://api.example.com/v3/leads \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "properties": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@doe.com",
    "project_amount": 20000
  },
  "currency": "USD",
  "ownerUserId": null,
  "partnerId": 42,
  "sourcePartnerId": 42,
  "userPartnerOwnerId": null,
  "assignedContactEmail": null,
  "deadLine": "2020-07-14T00:00:00",
  "note": "Very hot lead!",
  "status": null,
  "assignToPartnerOwner": null
}
'

import requests

url = "https://api.example.com/v3/leads"

payload = {
    "properties": {
        "firstName": "John",
        "lastName": "Doe",
        "email": "john@doe.com",
        "project_amount": 20000
    },
    "currency": "USD",
    "ownerUserId": None,
    "partnerId": 42,
    "sourcePartnerId": 42,
    "userPartnerOwnerId": None,
    "assignedContactEmail": None,
    "deadLine": "2020-07-14T00:00:00",
    "note": "Very hot lead!",
    "status": None,
    "assignToPartnerOwner": None
}
headers = {"Content-Type": "application/json-patch+json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    properties: {
      firstName: 'John',
      lastName: 'Doe',
      email: 'john@doe.com',
      project_amount: 20000
    },
    currency: 'USD',
    ownerUserId: null,
    partnerId: 42,
    sourcePartnerId: 42,
    userPartnerOwnerId: null,
    assignedContactEmail: null,
    deadLine: '2020-07-14T00:00:00',
    note: 'Very hot lead!',
    status: null,
    assignToPartnerOwner: null
  })
};

fetch('https://api.example.com/v3/leads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v3/leads",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'properties' => [
        'firstName' => 'John',
        'lastName' => 'Doe',
        'email' => 'john@doe.com',
        'project_amount' => 20000
    ],
    'currency' => 'USD',
    'ownerUserId' => null,
    'partnerId' => 42,
    'sourcePartnerId' => 42,
    'userPartnerOwnerId' => null,
    'assignedContactEmail' => null,
    'deadLine' => '2020-07-14T00:00:00',
    'note' => 'Very hot lead!',
    'status' => null,
    'assignToPartnerOwner' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v3/leads"

	payload := strings.NewReader("{\n  \"properties\": {\n    \"firstName\": \"John\",\n    \"lastName\": \"Doe\",\n    \"email\": \"john@doe.com\",\n    \"project_amount\": 20000\n  },\n  \"currency\": \"USD\",\n  \"ownerUserId\": null,\n  \"partnerId\": 42,\n  \"sourcePartnerId\": 42,\n  \"userPartnerOwnerId\": null,\n  \"assignedContactEmail\": null,\n  \"deadLine\": \"2020-07-14T00:00:00\",\n  \"note\": \"Very hot lead!\",\n  \"status\": null,\n  \"assignToPartnerOwner\": null\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v3/leads")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"properties\": {\n    \"firstName\": \"John\",\n    \"lastName\": \"Doe\",\n    \"email\": \"john@doe.com\",\n    \"project_amount\": 20000\n  },\n  \"currency\": \"USD\",\n  \"ownerUserId\": null,\n  \"partnerId\": 42,\n  \"sourcePartnerId\": 42,\n  \"userPartnerOwnerId\": null,\n  \"assignedContactEmail\": null,\n  \"deadLine\": \"2020-07-14T00:00:00\",\n  \"note\": \"Very hot lead!\",\n  \"status\": null,\n  \"assignToPartnerOwner\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/leads")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"properties\": {\n    \"firstName\": \"John\",\n    \"lastName\": \"Doe\",\n    \"email\": \"john@doe.com\",\n    \"project_amount\": 20000\n  },\n  \"currency\": \"USD\",\n  \"ownerUserId\": null,\n  \"partnerId\": 42,\n  \"sourcePartnerId\": 42,\n  \"userPartnerOwnerId\": null,\n  \"assignedContactEmail\": null,\n  \"deadLine\": \"2020-07-14T00:00:00\",\n  \"note\": \"Very hot lead!\",\n  \"status\": null,\n  \"assignToPartnerOwner\": null\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "creationDate": "2023-11-07T05:31:56Z",
  "properties": {},
  "partnerId": 123,
  "sourcePartnerId": 123,
  "userPartnerOwnerId": 123,
  "dealId": 123,
  "customerId": 123,
  "deadLine": "2023-11-07T05:31:56Z",
  "assignedDate": "2023-11-07T05:31:56Z",
  "acceptedDate": "2023-11-07T05:31:56Z",
  "refusedDate": "2023-11-07T05:31:56Z",
  "convertedDate": "2023-11-07T05:31:56Z",
  "abandonedDate": "2023-11-07T05:31:56Z",
  "status": "Unknown",
  "partnerName": "<string>",
  "dealName": "<string>",
  "customerName": "<string>",
  "source": "Unknown",
  "transferredLeadId": 123,
  "currency": "<string>",
  "ownerUserId": 123,
  "owner": {
    "id": 123,
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  }
}

Account

Attachments

Certifications

ChannelConflicts

ContactProperties

Contacts

Customers

CustomersProperties

DealPipelines

DealProperties

Deals

EmailTemplates

Groups

LeadProperties

Leads

LineItems

Notes

Onboarding

PartnerApplications

PartnerContactCertifications

PartnerContacts

PartnerProperties

Partners

PayoutProperties

Payouts

ProductPrices

Products

Programs

RewardProperties

Rewards

Subscriptions

TransactionProperties

Transactions

Create lead

Body

Response