Contacts

Contacts are either customers or leads.

post
Create contact

https://api.kiflo.com/v2/contacts
Create a new contact.
Request
Response
Request
Headers
Authorization
required
string
API Access Token using Bearer scheme.
Body Parameters
contactType
optional
string
The type of the contact. For contact representing customers, use "Client". For contacts representing new leads from landing page for instance, use "Lead".
leadSource
optional
string
The new lead source. Possible values: Website, Partner, Api
leadStatus
optional
string
The new contact status. Possible values : New, Accepted, Qualified, Deal, Unqualified
webSite
optional
string
The contact website address
phoneNumber
optional
string
The contact phone number
companyName
optional
string
The contact company name
partnerEmail
required
string
The email of the partner associated with the contact
externalContactId
optional
string
Your unique identifier used to identify the contact
lastName
required
string
The contact lastname
firstName
required
string
The contact firstname
email
required
string
The contact email
Response
200: OK
Returns the technical Resels identifier for the new contact.
{
externalContactId: "YOUR_CUSTOM_CONTACT_ID",
contactId: 42,
email: "john.doe@foobar.com"
}

patch
Update Contact

https://api.kiflo.com/v2/contacts/:id
Update an existing contact.
Request
Response
Request
Path Parameters
id
required
integer
The ID of the contact to update
Headers
Authorization
required
string
The API Access Token using Bearer scheme
Body Parameters
externalContactId
optional
string
Your unique identifier used to identify the contact
firstName
optional
string
The contact's first name
lastName
optional
string
The contact's last name
email
optional
string
The contact's email address
companyName
optional
string
The contact's company name
phoneNumber
optional
string
The contact's phone number
webSite
optional
string
The website URL of the contact's company
note
optional
string
Additional notes about the contact
leadStatus
optional
string
If the contact type is Lead, the status of the lead: New, Accepted, Qualified, Deal or Unqualified
leadSource
optional
string
The source of the lead: Website, Partner, Api or Zapier
contactType
optional
string
The type of contact: Client or Lead
Response
200: OK
Returns the updated contact.
{
id: 42,
externalContactId: "YOUR_CUSTOM_IDENTIFIER",
partnerId: 10,
firstName: "John",
lastname: "Doe",
email: "john.doe@foobar.com",
companyName: "FooBar, Inc",
phoneNumber: "+33 1 24 56 48 08",
webSite: "https://www.resels.com/",
note: "This lead was very interested in your product",
leadStatus: "Qualified",
leadSource: "Partner",
contactType: "Lead"
}

get
Get Contact

https://www.kiflo.com/v2/contacts/:id
Get a specific contact details.
Request
Response
Request
Path Parameters
id
required
number
The technical Kiflo identifier of the contact to get.
Headers
Authorization
required
string
API Access Token using Bearer scheme
Response
200: OK
Returns a single contact.
{
id: 42,
externalContactId: "YOUR_CUSTOM_IDENTIFIER",
partnerId: 10,
firstName: "John",
lastname: "Doe",
email: "john.doe@foobar.com",
companyName: "FooBar, Inc",
phoneNumber: "+33 1 24 56 48 08",
webSite: "https://www.resels.com/",
note: "This lead was very interested in your product",
leadStatus: "Qualified",
leadSource: "Partner",
contactType: "Lead"
}

get
List Contacts

https://api.kiflo.com/v2/contacts
List existing contacts.
Request
Response
Request
Headers
Authorization
required
string
API Access Token using Bearer scheme
Query Parameters
email
optional
string
The email of the contacts to return.
offset
optional
integer
The offset from which results must be returned. Default is0.
limit
optional
integer
The maximum number of results to return. Default is 20.
sort_by
optional
string
The name of the property used to sort the results. Default is CreationDate.
order_by
optional
string
The sorting direction, can be Asc or Desc. Default is Desc.
Response
200: OK
Returns an array of contacts.
[
{
id: 42,
externalContactId: "YOUR_CUSTOM_IDENTIFIER",
partnerId: 10,
firstName: "John",
lastname: "Doe",
email: "john.doe@foobar.com",
companyName: "FooBar, Inc",
phoneNumber: "+33 1 24 56 48 08",
webSite: "https://www.resels.com/",
note: "This lead was very interested in your product",
leadStatus: "Qualified",
leadSource: "Partner",
contactType: "Lead"
},
{...}
]