The Cliengo API

Welcome to the Cliengo developer hub. You'll find comprehensive guides and documentation to help you start working with Cliengo as quickly as possible, as well as support if you get stuck. Let's jump right in!

Guides
 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/account
curl 'https://api.cliengo.com/1.0/account/?api_key=your_api_key' 
A binary file was returned

You couldn't be authenticated

{
  id: "527a78fde4b0db03284a8f7b",
  email: "demo@cliengo.com",
  name: "Demo Cliengo",
  contactName: "Cliengo",
  whiteLabelId: "54b8018fe4b0268f4f942308",
  creationDate: "2013-11-06T00:00:00.000Z",
  taxId: "30-12312312-8",
  address: "Zapiola 196",
  taxIdName: "Microsoft S.A.",
  phone: "+541133261332",
  leadCount: 345,
  leadLimit: 1200,
  language: "es",
  timeZone: "-03:00",
}

Body Params

taxId
string

An Individual tax ID number is a number issued by the Internal Revenue Service

name
string

Account Name

contactName
string

Main user contact name

 
Suggest Edits

/account

Update an Account

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
puthttps://api.cliengo.com/1.0/account
curl --request PUT \
  --url https://api.cliengo.com/1.0/account
var request = require("request");

var options = { method: 'PUT', url: 'https://api.cliengo.com/1.0/account' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.cliengo.com/1.0/account")

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

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.cliengo.com/1.0/account");

xhr.send(data);
import requests

url = "https://api.cliengo.com/1.0/account"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  id: "527a78fde4b0db03284a8f7b",
  email: "demo@cliengo.com",
  name: "Demo cliengo",
  contactName: "cliengo",
  whiteLabelId: "54b8018fe4b0268f4f942308",
  creationDate: "2013-11-06T00:00:00.000Z"
}

Body Params

name
string
contactName
string
 
Suggest Edits

/account/payments

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/account/payments
curl "https://api.cliengo.com/1.0/account/payments?page=2&offset=5"
A binary file was returned

You couldn't be authenticated

{
  "paging": {
    "total": 1
  },
  "results": [
    {
      "id": "5890c98b3ef600a730d21f3c",
      "creationDate": "2017-01-31T14:29:47.778-03:00",
      "paymentDate": "2017-01-31T14:29:47.779-03:00",
      "paymentMethod": "Paypal",
      "ammount": 1337.0,
      "paymentForDays": 30,
      "currency": "ARS",
      "invoiceUrl": "https://api.cliengo.com/1.0/account/me/payments/5890c98b3ef600a730d21f3c/downloadInvoice"
    }
  ]
}

Query Params

page
int32

Page

offset
int32
 
Suggest Edits

/account/subscription

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.cliengo.com/1.0/account/subscription
curl --request POST \
  --url https://api.cliengo.com/1.0/account/subscription
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.cliengo.com/1.0/account/subscription' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.cliengo.com/1.0/account/subscription")

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

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.cliengo.com/1.0/account/subscription");

xhr.send(data);
import requests

url = "https://api.cliengo.com/1.0/account/subscription"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
	"paymentMethod":"MERCADOPAGO",
  "token":"sha256AESsha1ahreloco",
	"newPlan":"CLIENGO_FULL",
   "id": "sha256AESsha1ahreloco",
   "public_key": "PUBLIC_KEY",
   "card_id": null,
   "luhn_validation": true,
   "status": "active",
   "date_used": null,
   "card_number_length": 16,
   "date_created": "2015-04-16T13:06:25.525-04:00",
   "first_six_digits": "555555",
   "last_four_digits": "3704",
   "security_code_length": 3,
   "expiration_month": 6,
   "expiration_year": 2017,
   "date_last_updated": "2015-04-16T13:06:25.525-04:00",
   "date_due": "2015-04-24T13:06:25.531-04:00",
   "live_mode": false,
   "cardholder": {
       "identification": {
           "number": "23456789",
           "type": "type"
       },
       "name": "name"
   }
}

Body Params

paymentMethod
string
required

Expects: MERCADOPAGO, PAYPAL.

token
string
required

The token used to validate the payment. Has to be obtained with MercadoPago/Paypal beforehand.

newPlan
string
required

Plan to which the user is subscribing to.

 
Suggest Edits

/account/plan

Retrieve a subscription plans for Cliengo by planId

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/account/plan
curl --request GET \
  --url https://api.cliengo.com/1.0/account/plan
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.cliengo.com/1.0/account/plan' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.cliengo.com/1.0/account/plan")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.cliengo.com/1.0/account/plan");

xhr.send(data);
import requests

url = "https://api.cliengo.com/1.0/account/plan"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "CLIENGO_BASIC",
  "name": "Cliengo Básico",
  "leadLimit": 100,
  "websiteLimit": 2,
  "userLimit": 3,
  "description": "Cliengo básico, 100 leads por mes",
  "priceARS": 450,
  "priceUSD": 29.0,
  "integrationsAllowed": true,
  "imageUrl": "https://res.cloudinary.com/hbrrdozyj/image/upload/v1484836411/plan_basic_afyhbl.png"
}
 
 
post/account
{
	"email" : "skynet@ai.com",
	"name" : "John Connor",
	"password" : "123456",
	"companyName" : "Skynet",
	"site" : "www.google.com/deepmind"
}
A binary file was returned

You couldn't be authenticated

{
	"companyId": "companyId",
  "websiteId": "websiteId"
}
 

IMPORTANT:
This is a restricted API call. You must be specifically whitelisted in onder to use this endpoint.
Get in contact with hello@cliengo.com to ask for authorization.

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/sites
curl --request GET \
  --url https://api.cliengo.com/1.0/sites
var request = require("request");

var options = { method: 'GET', url: 'https://api.cliengo.com/1.0/sites' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.cliengo.com/1.0/sites")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.cliengo.com/1.0/sites");

xhr.send(data);
import requests

url = "https://api.cliengo.com/1.0/sites"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  id: "55b6909444ae8172ac91b07a",
  url: "www.yourwebsite.com",
  creationDate: "2015-07-27T17:12:04.284-03:00",
  email: "demo@yourwebsite.com",
  companyId: "55b6909444ae8172ac91b078",
  title: "Demo websites",
  type: "WEBSITE"
}
 

A Website is an entity that links any existing website into Cliengo.

After you create an Account in Cliengo, the next thing you have to do is to create a Website. In this entity you'll find the main configuration for your Contact adquisition strategy.

Query Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.cliengo.com/1.0/sites
curl --data "email=demo@yourcompany.com&title=Your_website&url=www.yourdemowebsite.com" https://api.cliengo.com/1.0/sites?api_key=your_api_key' 
A binary file was returned

You couldn't be authenticated

{
  id: "55b6909444ae8172ac91b07a",
  url: "www.yourwebsite.com",
  creationDate: "2015-07-27T17:12:04.284-03:00",
  email: "demo@yourwebsite.com",
  companyId: "55b6909444ae8172ac91b078",
  title: "Demo websites"
}

Body Params

email
string
required

Email asociated with your website. You'll receive Contacts to this email.

title
string
required

Title for your website.

url
string
required

The URL asociated with your website.

ccEmails
string

This Carbon Copy Emails will be copied on everty new Contact received. Separate by commas to add many.

externalId
string

Reference that you can use to link the website to your system.

 
Suggest Edits

/sites/:id

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/sites/id
curl 'https://api.cliengo.com/1.0/websites/{websiteId}?api_key=your_api_key' 
A binary file was returned

You couldn't be authenticated

{
  id: "55b6909444ae8172ac91b07a",
  url: "www.yourwebsite.com",
  creationDate: "2015-07-27T17:12:04.284-03:00",
  email: "demo@yourwebsite.com",
  companyId: "55b6909444ae8172ac91b078",
  title: "Demo websites"
}

Path Params

id
string
required
 
Suggest Edits

/sites/:id

Update a Website entity

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
puthttps://api.cliengo.com/1.0/sites/id
curl --request PUT \
  --url https://api.cliengo.com/1.0/sites/id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.cliengo.com/1.0/sites/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.cliengo.com/1.0/sites/id")

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

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.cliengo.com/1.0/sites/id");

xhr.send(data);
import requests

url = "https://api.cliengo.com/1.0/sites/id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  id: "55b6909444ae8172ac91b07a",
  url: "www.yourwebsite.com",
  creationDate: "2015-07-27T17:12:04.284-03:00",
  email: "demo@yourwebsite.com",
  companyId: "55b6909444ae8172ac91b078",
  title: "Demo websites",
  type: "WEBSITE"
}

Path Params

id
string
required

Body Params

email
string

Email asociated with your website. You'll receive Contacts to this email.

title
string

Title for your website.

url
string

The URL asociated with your website.

ccEmails
string

This Carbon Copy Emails will be copied on everty new Contact received.

externalId
string

Reference that you can use to link the website to your system.

 
Suggest Edits

/sites/chatbots

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/sites/chatbots
curl 'https://api.cliengo.com/1.0/sites/chatbots?api_key=your_api_key' 
A binary file was returned

You couldn't be authenticated

{
  "paging": {
    "total": 1
  },
  "results": [
    {
      "askTelephone": "REQUIRED",
      "askEmail": "REQUIRED",
      "askDni": "NOTREQUIRED",
      "color": "5ba0d0",
      "saluteTime": 0,
      "welcomeMessage": "",
      "language": "es",
      "newTitle": "",
      "name": "Pilar",
      "askTimeToCall": true,
      "companyId": "58504f4c93f4f071f9d654ac",
      "telephoneAnswer": "",
      "customerSupportTime": "9 a 18hs.",
      "addressAnswer": "",
      "id": "58504f6e93f4f071f9d65535"
    }
  ]
}

Path Params

id
string
required
 
Suggest Edits

/sites/chatbots

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.cliengo.com/1.0/sites/chatbots
{
	"botColor" : "#4bbf6a",
  "botName" : "Pilar",
  "botWelcomeMsg" : "Hey, i'm online, how can i help you?",
  "botProfilePic" : "http://url.com/picture.jpg"
  "websiteId" : "15428rye8hfaidjalkf"
}
A binary file was returned

You couldn't be authenticated

{
  "chatbotId" : "5i51492jofaidsfj9o"
}
 
Suggest Edits

/sites/:id/chatbot

 
get/sites/id/chatbot
curl 'https://api.cliengo.com/1.0/sites/:id/chatbot?api_key=your_api_key' 
A binary file was returned

You couldn't be authenticated

{
  "askTelephone": "OPTIONAL",
  "askEmail": "OPTIONAL",
  "askDni": "NOTREQUIRED",
  "colorHex": "5BA0D0",
  "language": "es",
  "saluteTime": 15,
  "telephoneAnswer": "",
  "addressAnswer": "Yes our address is right in your heart.",
  "initialMessage": "Hey there, how are you?",
  "isRobotAnswer": "Hey there, i'm a chatbot! People usually call me skynet though.",
  "priceAnswer": "",
  "customerSupportTime": "9 to 18 hs",
  "botName": "Pilar",
  "initialMessageOn": true,
  "newTitleOn": false,
  "telephoneAnswerOn": false,
  "answerCvOn": false,
  "customerSupportTimeOn": false,
  "isRobotAnswerOn": false,
  "priceAnswerOn": false,
  "addressAnswerOn": false,
  "dontAskTimeToCall": false,
  "botNameOn": true,
  "companyId": "581b8133d4c611028e9b0e19",
  "enabled": true
}

Path Params

id
string
required
 
Suggest Edits

/sites/:id/chatbot

Customize your ChatBot via API!

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
puthttps://api.cliengo.com/1.0/sites/id/chatbot
curl 'https://api.cliengo.com/1.0/chatbots/<websiteId>?api_key=your_api_key' 
def leadaki = new HTTPBuilder(http://www.api.leadaki.com/1.0/chatbots/<websiteId>?api_key=APIKEY)
def reqBody = [newTitle: 'Sales Chat', botName: 'Alejandro']
leadaki.put(reqBody)
A binary file was returned

You couldn't be authenticated

{
	"chatbotId" : "ID"
}

Path Params

id
string
required

Body Params

askEmail
string

Tells the bot how much to insist on getting a email (REQUIRED, NOTREQUIRED, OPTIONAL)

askDni
string

Tells the bot how much to insist on getting a ID/DNI (REQUIRED, NOTREQUIRED, OPTIONAL)

askTelephone
string

Tells the bot how much to insist on getting a telephone (REQUIRED, NOTREQUIRED, OPTIONAL)

askTimeToCall
boolean

If set in true, after obtaining the client's phone, the bot will ask at which time they'd rather be called.

question1
string

Additional question for when the flow finishes

question2
string

Additional question for when the flow finishes

question3
string

Additional question for when the flow finishes

addressAnswer
string

Defines what your bot says when someone asks for your company address.

telephoneAnswer
string

Defines what your bot says when someone asks for your company phone.

isRobotAnswer
string

Customized bot answer for when it announces that you are chatting with a robot

welcomeMessage
string

Defines what your bot says when it pops up (see saluteTime)

customerSupportTime
string

Defines what your bot says when someone asks for your company customer support time.

profilePic
string

An image URL or a base64 encoded image

color
string

Change chat color based on a hexadecimal color (Ex: 5BA0D0)

language
string

Chat language (en, es, pt)

newTitle
string

Chatbot window title

name
string

Your chatbot name.

saluteTime
int32

Time until the chat pops on a website in seconds.

customerSupportTimeOn
boolean

Makes your bot answer/not answer when someone asks for your company customer support time.

isRobotAnswerOn
boolean

If set on true, the bot will reveal it's true self at the begging of the chat. (Will tell the user it's a chat bot and not a real operator)

 
Suggest Edits

/sites/:id/chatbot/triggers

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/sites/id/chatbot/triggers
curl --request GET \
  --url https://api.cliengo.com/1.0/sites/id/chatbot/triggers
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.cliengo.com/1.0/sites/id/chatbot/triggers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.cliengo.com/1.0/sites/id/chatbot/triggers")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.cliengo.com/1.0/sites/id/chatbot/triggers");

xhr.send(data);
import requests

url = "https://api.cliengo.com/1.0/sites/id/chatbot/triggers"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
	"response":"Nice! You speak Latin!",
  "stopNextMessage": true,
  "ignoreLead": false,
  "matches" : [
    {
  		"type": "equals",
  		"value": "lorem ipsum dolor sit amet"
		},
    {
  		"type": "regex",
  		"value": ".*ipsum.*dol.*amet"
		},
  	{
  		"type": "contains",
  		"value": "ipsum dolor sit"
		},
		{
  		"type": "startswith",
  		"value": "lorem ipsum"
		},
    {
  		"type": "endswith",
  		"value": "sit amet"
		},
    {
  		"type": "phrase",
  		"value": "lorems ipsums doloris sitis ametos"
		}    
  ]
}

Path Params

id
string
required
 
Field
Type (default)
Description

response

string

Bot's answer to the message.

stopNextMessage

boolean (true)

Will only send the response to the trigger. The bot will continue the conversation as normal once the user sends another message.

ignoreLead

boolean (false)

Marks the lead as spam.

matchesList

array_object

List of matchers for the trigger. Defined in the json below.

matches[i].type

One of this strings:

-phrase
-contains
-startswith
-endswith
-equals

IMPORTANT: ALL match strategies are case-insensitive)

phrase: Use some intelligence to match if root keywords in user message match with "value"

regex: Match the regular expression in "value"

equals: Matches if user message is exactly equals to "value"

contains: Matches if user message contains "value"

startswith: Matches if user message starts with "value"

endswith: Matches if user message ends with "value"

matches[i].value

string

the string value you want to match.

Suggest Edits

/sites/:id/chatbot/triggers

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.cliengo.com/1.0/sites/id/chatbot/triggers
curl --request POST \
  --url https://api.cliengo.com/1.0/sites/id/chatbot/triggers
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.cliengo.com/1.0/sites/id/chatbot/triggers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.cliengo.com/1.0/sites/id/chatbot/triggers")

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

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.cliengo.com/1.0/sites/id/chatbot/triggers");

xhr.send(data);
import requests

url = "https://api.cliengo.com/1.0/sites/id/chatbot/triggers"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

Body Params

response
string

Bot's answer to the message.

stopNextMessage
boolean

Will only send the response to the trigger. The bot will continue the conversation as normal once the user sends another message.

ignoreLead
boolean

Marks the lead as spam.

matchesList
array

List of matchers for the trigger. Defined in the json below.

 

Check full fields documentation at Triggers-GET

Suggest Edits

/sites/:id/chatbot/triggers

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
puthttps://api.cliengo.com/1.0/sites/id/chatbot/triggers
curl --request PUT \
  --url https://api.cliengo.com/1.0/sites/id/chatbot/triggers
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.cliengo.com/1.0/sites/id/chatbot/triggers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.cliengo.com/1.0/sites/id/chatbot/triggers")

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

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.cliengo.com/1.0/sites/id/chatbot/triggers");

xhr.send(data);
import requests

url = "https://api.cliengo.com/1.0/sites/id/chatbot/triggers"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

Body Params

response
string

Bot's answer to the message.

stopNextMessage
boolean

Will only send the response to the trigger. The bot will continue the conversation as normal once the user sends another message.

ignoreLead
boolean

Marks the lead as spam.

matchesList
array

List of matchers for the trigger. Defined in the json below.

 

Check full fields documentation at Triggers-GET

Suggest Edits

/contacts

Get all contacts

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/contacts
curl "https://api.cliengo.com/1.0/contacts?api_key={your_api_key}"
curl "https://api.cliengo.com/1.0/contacts" -H "authorization:{jwt}"
A binary file was returned

You couldn't be authenticated

{
  paging: {
    limit: 50,
    total: 2,
    offset: 0
	},
  results: [
    {
      id: "5c07d268e4b04608058f653c",
      accountId: "560596e8e440153ae0337b1d",
      websiteId: "56152273e4b49dd3a41b4b01",
      status: "new",
      name: "Norma",
      email: "norma@gmail.com",
      phone: "0362 427-3574",
      internationalPhoneNumber: "+543624273574",
      whatsappPhoneNumber: "543624273574",
      creationDate: "2018-11-05T13:28:08.058Z",
      lastUpdateDate: "2018-11-05T13:28:52+0000",
      lastName: "",
      age: 0,
      ip: "186.111.157.108",
      referalUrl: "android-app://com.google.android.gm",
      landingUrl: "android-app://com.google.android.gm",
      conversionUrl: "https://landing.test.com.ar?utm_source=newsletter&utm_medium=email",
      message: "cliente: hola, quiero comprar un robot asesor: será un placer ayudarte, cuál es tu nombre? cliente: Norma asesor: Norma yo me encargo de ponerte en contacto con un asesor para que responda tu consulta asesor: podrás dejarme tu email y teléfono con código de área? cliente: Mi telefono es 3624273574 asesor: te puedo pedir además tu email? norma@gmail.com asesor: perfecto! asesor: con la información que me pasaste un asesor te contactará a la brevedad.",
      assignedTo: {
        name: "Marta Perez",
        email: "marta@test.com.ar",
        creationDate: "2017-09-05T12:57:43+0000",
        userId: "59ae9ff3e4b0b259bc36afe6",
        phone: ""
      },
      geoip: {
        latitude: "-27.4667",
        longitude: "-58.8333",
        country: "AR",
        state: "Corrientes",
        city: "Corrientes",
        zipCode: "3400"
      },
      duplicatedContact: false,
      notes: [ ],
      medium: "Desconocido",
      source: "newsletter",
      mediumTranslate: "Desconocido",
      sourceTranslate: "newsletter",
      customParams: {
        ldkCompanyId: "560596e8e440153ae0337b1d",
        ldkWebsiteId: "56152273e4b49dd3a41b4b01",
        conversationId: "5c07d05ce4b042ff7791ff83",
        channel: "CHATBOT",
      },
      rating: 5,
      conversationId: "5a07d06ce4b032ff7791ff82",
      utmSource: "newsletter",
      utmMedium: "Desconocido",
      utmCampaign: "Desconocido",
      utmContent: "Desconocido",
      utmTerm: "Desconocido",
      accountName: "Company Test",
      websiteName: "Website Test"
    },
    {
      id: "55b7d5700364dfc80124b69d",
      status: "new",
      name: "Pablo Picaso",
      email: "pablo@picaso.com",
      phone: "4758948575",
      creationDate: "2015-07-28T16:18:08.215-03:00",
      ip: "171.24.4.55",
      conversionUrl: "referer",
      landingUrl: "refererTracking",
      message: "mensaje nuevo"
    }
  ]
}

Query Params

query
string

find this query String within fields name, email and phone.

assignedTo
string

The user's ID who the contact is assigned

websiteId
string

filter contacts received in this websiteId

status
string

the contact status. Posible values are: new, active, long_term and client

since
date

filter date since

until
date

filter date until

lastUpdateDate
date

filter since last update

offset
string

you can move the lower limit of the result block (Default is 0)

limit
string

To reduce the page size you can change the limit parameter (Default is 25)

 

You can retrieve all Contacts you have in Cliengo CRM.

Suggest Edits

/contacts

Add contact

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.cliengo.com/1.0/contacts
{
  name: "John",
  email: "john@somedomain.com",
  phone: "+54 11 9999-9999",
  websiteId: "55b7dce30364dfc80124b6aa",
  status: "new",
  message: "Hi! I'm John", 
  customFields : {
  		customFieldKey1: '123456789', 
  		customFieldKey2: 'superValue'
  }
  entryMethod: "FORM"
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

websiteId
string
required

Website

name
string

Contact Name

email
string

E-mail contact

phone
string

Phone

ip
string

IP

conversionUrl
string

Conversion URL

landingUrl
string

Landing URL

message
string

Message

externalStatus
string

Free external reference

entryMethod
string

WHATSAPP, FB_LEADADS, FORM, CHATBOT, API, ZAPIER

status
string
 
Suggest Edits

/contacts/:contactId

Get contact for ID

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/contacts/contactId
curl 'https://api.cliengo.com/1.0/contact/{contactId}/?api_key={your_api_key}' 
A binary file was returned

You couldn't be authenticated

{
  id: "55b7d5700364dfc80124b69d",
  status: "new",
  name: "Pablo Picaso",
  email: "pablo@picaso.com",
  phone: "4758948575",
  creationDate: "2015-07-28T16:18:08.215-03:00",
  ip: "171.24.4.55",
  conversionUrl: "referer",
  landingUrl: "refererTracking",
  message: "mensaje nuevo",
  customParams : {
  		customParamKey1: '123456789', 
  		customParamKey2: 'superValue'
  }
}

Path Params

contactId
string
required

ID Contact

 
Suggest Edits

/contacts/:contactId

Update contact

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
puthttps://api.cliengo.com/1.0/contacts/contactId
curl -X PUT 'https://api.cliengo.com/1.0/contac' --data "websiteId=55b7dce30364dfc80124b6aa&email=diego@leadaki.com&name=diego&phone=5437485696&ip=123.4.5.6&conversionUrl=&landingUrl=&status=active&message=mensaje&externalStatus=1234&api_key=your_api_key"
A binary file was returned

You couldn't be authenticated

{
  id: "55b7ddad0364dfc80124b6ae"
  status: "active"
  name: "diego"
  email: "diego@cliengo.com"
  phone: "5437485696"
  creationDate: "2015-07-28T16:53:17.907-03:00"
  websiteId: "55b7dce30364dfc80124b6aa"
  ip: "123.4.5.6"
  message: "esto es un mensaje"
}

Path Params

contactId
string
required

Body Params

name
string
email
string
phone
string
websiteId
string
ip
string
conversionUrl
string
landingUrl
string
message
string
externalStatus
string

Free reference user

 
Suggest Edits

/contacts/:contactId/messages

Get contact messages

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/contacts/contactId/messages
curl 'https://api.cliengo.com/1.0/contacts/{contactId}/messages?api_key=TEST_API_KEY'
A binary file was returned

You couldn't be authenticated

{
results: [
    {
      creationDate: "2014-07-04T18:06:05.170-03:00",
      message: "Mensaje de prueba"
    },
    {
      creationDate: "2014-07-04T18:07:08.796-03:00",
      message: "Adiós!!!!"
    }
	],
	size: 2
}

Path Params

contactId
string
required

Id Contact

 
Suggest Edits

/contacts/:contactId/messages

Add contact messages

 
post/contacts/contactId/messages
curl -X POST 'https://api.cliengo.com/1.0/contacts/{contactId}/message'  --data "message={you_message}&api_key=your_api_key"
A binary file was returned

You couldn't be authenticated

{
	creationDate: "Jul 29, 2015 11:37:17 AM" 
	message: "mensaje 2"
}

Path Params

contactId
string
required

Body Params

message
string
required
 
Suggest Edits

/contacts/:contactId/notes

Get contact notes

 
get/contacts/contactId/notes
curl 'https://api.cliengo.com/1.0/contacts/{contactId}/messages?api_key=TEST_API_KEY'
A binary file was returned

You couldn't be authenticated

{
	results: [1]
		0:  {
				creationDate: "2015-07-29T12:24:58.606-03:00"
        creatorId: "55b8f02f03641e00511a46b5"
        message: "mensaje 2"
        }
	size: 1
}

Path Params

contactId
string
required
 
Suggest Edits

/contacts/:contactId/notes

Add contact notes

 
post/contacts/contactId/notes
curl -X POST 'https://api.cliengo.com/1.0/contacts/{contactId}/message' --data "api_key=your_api_key&message={you_message}" 
A binary file was returned

You couldn't be authenticated

{
  creationDate: "2015-07-29T12:29:51.113-03:00"
  creatorId: "55b8f02f03641e00511a46b5"
  message: "mensaje de prueba"
}

Path Params

contactId
string
required

Body Params

message
string
required

Text note

 
Suggest Edits

/contacts/:contactId/phone-calls

Get contact phone calls

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/contacts/contactId/phone-calls
curl 'https://api.cliengo.com/1.0/contacts/{contactId}/phone-calls?api_key=TEST_API_KEY'
A binary file was returned

You couldn't be authenticated

{
  results: [2]
    0:  {
      id: "null"
      creationDate: "2015-07-29T16:17:26.102-03:00"
      answerTime: ""
      duration: ""
      endTime: ""
      from: "541155555551"
      startTime: ""
      to: "541155555555"
    }-
    1:  {
      id: "null"
      creationDate: "2015-07-29T16:19:41.099-03:00"
      answerTime: ""
      duration: ""
      endTime: ""
      from: "541155555551"
      startTime: ""
      to: "541155555555"
    }
  size: 2
}

Path Params

contactId
string
required
 
Suggest Edits

/contacts/:contactId/phone-calls

Add contact phone calls

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.cliengo.com/1.0/contacts/contactId/phone-calls
curl -X POST 'https://api.cliengo.com/1.0/contacts/phone-calls'  --data "callStatus=&callerName=John Doe&event=&to=&callUUID=&recordingURL=&totalCost=&answerTime=&direction=&billRate=&hangupCause=&duration=&endTime=&startTime=&from=&api_key=YOURAPIKEY"
A binary file was returned

You couldn't be authenticated

{
id: "null"
creationDate: "2015-07-29T16:23:03.761-03:00"
answerTime: ""
duration: ""
endTime: ""
from: "541155555551"
startTime: ""
to: "541155555555"
}

Path Params

contactId
string
required

Body Params

from
string
required

From cal

to
string
required

To call

callStatus
string

Call status

callerName
string

Caller name

event
string

Event

callUUID
string

Call ID

recordingURL
string

Recording URL

totalCost
string

Total cost

answerTime
string

Answer Time

direction
string

Direction call

billRate
string

Bill rate

hangupCause
string

Hangup cause

duration
string

Duration call

billDuration
string

Bill duration call

endTime
string

End time

startTime
string

Start time

 
Suggest Edits

/contacts/stats/byFirstContactMethod

Get all contacts

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/contacts/stats/byFirstContactMethod
curl --request GET \
  --url https://api.cliengo.com/1.0/contacts/stats/byFirstContactMethod
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.cliengo.com/1.0/contacts/stats/byFirstContactMethod' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.cliengo.com/1.0/contacts/stats/byFirstContactMethod")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.cliengo.com/1.0/contacts/stats/byFirstContactMethod");

xhr.send(data);
import requests

url = "https://api.cliengo.com/1.0/contacts/stats/byFirstContactMethod"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  phone: 10,
  from: 13,
  chat: 25
}

Query Params

sinceDaysAgo
int32

Days ago for grouping this stats. Cero or means no limit

 

You can retrieve all Contacts you have in Cliengo CRM.

Suggest Edits

/contacts/stats/lastWeek

Retrieves last seven days basic statistics. That is, last seven days clients, sales, and conversations.

 
get/contacts/stats/lastWeek
curl --request GET \
  --url http://example.com/contacts/stats/lastWeek
var request = require("request");

var options = { method: 'GET',
  url: 'http://example.com/contacts/stats/lastWeek' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://example.com/contacts/stats/lastWeek")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://example.com/contacts/stats/lastWeek");

xhr.send(data);
import requests

url = "http://example.com/contacts/stats/lastWeek"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[{
  "label": "Conversaciones",
  "color": "#7266ba",
  "data": [
    ["Lu", 210],
    ["Ma", 120],
    ["Mi", 270],
    ["Ju", 240],
    ["Vi", 160],
    ["Sa", 390],
    ["Do", 150]
  ]
}, {
  "label": "Clientes",
  "color": "#2f80e7",
  "data": [
    ["Lu", 70],
    ["Ma", 85],
    ["Mi", 59],
    ["Ju", 93],
    ["Vi", 66],
    ["Sa", 86],
    ["Do", 60]
  ]
}, {
  "label": "Ventas",
  "color": "#00D062",
  "data": [
    ["Lu", 12],
    ["Ma", 4],
    ["Mi", 8],
    ["Ju", 11],
    ["Vi", 6],
    ["Sa", 15],
    ["Do", 3]
  ]
}]
{
  error: "bad request"
}
 

Retrieves last seven days basic statistics. That is, last seven days clients, sales, and conversations.

This endpoint is still under development.

Suggest Edits

/contacts/count

Retrieves the total amount o contacts for the company

 
get/contacts/count
curl --request GET \
  --url http://example.com/contacts/count
var request = require("request");

var options = { method: 'GET', url: 'http://example.com/contacts/count' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://example.com/contacts/count")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://example.com/contacts/count");

xhr.send(data);
import requests

url = "http://example.com/contacts/count"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  count: 1200
}
{
  error: "bad-request"
}

Query Params

websiteId
string

contacts received in this websiteId

 

Retrieves the total amount o contacts for the company

This endpoint is under development

Suggest Edits

/contacts/countsales

Retrieves the total amount of contacts which converted to sales for the company

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/contacts/countsales
curl --request GET \
  --url https://api.cliengo.com/1.0/contacts/countsales
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.cliengo.com/1.0/contacts/countsales' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.cliengo.com/1.0/contacts/countsales")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.cliengo.com/1.0/contacts/countsales");

xhr.send(data);
import requests

url = "https://api.cliengo.com/1.0/contacts/countsales"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  count: 1200
}
{
  error: "bad-request"
}
 

Retrieves the total amount of contacts which converted to sales for the company

This endpoint is under development

Suggest Edits

/integrationContacts

Get first 50 integrations of contact for Account (multiple websites)

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/contacts/integrations/
curl --request GET \
  --url https://api.cliengo.com/1.0/contacts/integrations/
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.cliengo.com/1.0/contacts/integrations/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.cliengo.com/1.0/contacts/integrations/")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.cliengo.com/1.0/contacts/integrations/");

xhr.send(data);
import requests

url = "https://api.cliengo.com/1.0/contacts/integrations/"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[{
"id":"5c48c327e4b0db53b5d6b6d0",
"from":"CLIENGO",
"to":"WEBHOOK",
"status":"ERRORED",
"contact":{
"id":"5c48c327e4b0db53b5d6b6cb",
"accountId":"5c488c1be4b0db53b5d6b1cc",
"websiteId":"5c48c326e4b0db53b5d6b6c6",
"status":"new",
"name":"contact5",
"email":"contact5@gmail.com",
"phone":"1122334455",
"creationDate":"2019-01-23T19:40:23.091Z",
"lastUpdateDate":"Jan 23, 2019 7:40:23 PM",
"lastName":"",
"ip":"ip1",
"referalUrl":"rt1",
"landingUrl":"rt1",
"conversionUrl":"referer1",
"message":"Hello bot",
"geoip":{
},
"duplicatedContact":false,
"notes":[
],
"medium":"referral",
"source":"rt1",
"mediumTranslate":"Referencia",
"sourceTranslate":"rt1",
"rating":2,
"utmSource":"rt1",
"utmMedium":"referral",
"utmCampaign":"",
"utmContent":"",
"utmTerm":"",
"accountName":"Leadaki (test env)",
"websiteName":"demoWeb"
},
"website":{
"id":"5c48c326e4b0db53b5d6b6c6",
"url":"www.demoweb.com",
"creationDate":"2019-01-23T19:40:22.794Z",
"email":"false@gmail.com",
"companyId":"5c488c1be4b0db53b5d6b1cc",
"title":"demoWeb",
"type":"WEBSITE",
"enableChat":true,
"labs":{
},
"deleted":false,
"availableSmartTriggers":[
{
"name":"all",
"value":"GLOBAL"
}
]
},
"company":{
"id":"5c488c1be4b0db53b5d6b1cc",
"email":"marianoyepes@gmail.com",
"phone":"+541133261336",
"name":"Leadaki (test env)",
"contactName":"Leadaki (test env)",
"creationDate":"Jan 23, 2019 3:45:31 PM",
"whiteLabelId":"5c488c1be4b0db53b5d6b1ca",
"whiteLabelName":"Whitelabel Leadaki",
"isCliengoReseller":false,
"whiteLabelLogoUrl":"https://res.cloudinary.com/hbrrdozyj/image/upload/v1435333518/leadaki_220_50_yuodjx.png",
"taxIdName":"Leadaki (test env)",
"leadCount":10,
"leadLimit":0,
"language":"en",
"timeZone":"-3:00",
"leadResetDate":"Feb 22, 2019 3:45:31 PM",
"daysToLeadResetDate":30,
"planCurrency":"USD",
"planName":"",
"labs":{
},
"chatUrl":"ws://localhost:9008",
"hasSubscription":false,
"forceChargebee":false,
"forceMercadoPago":false,
"quickstartSteps":{
"CREATE_ACCOUNT_COMPLETED":true,
"CHOOSE_APPEARANCE_VISITED":false,
"CHOOSE_APPEARANCE_COMPLETED":false,
"CUSTOMIZE_CONVERSATION_VISITED":false,
"CUSTOMIZE_CONVERSATION_COMPLETED":false,
"CREATE_AUTOMATIC_REPLY_VISITED":false,
"CREATE_AUTOMATIC_REPLY_COMPLETED":false,
"INSTALL_CHATBOT_VISITED":false,
"INSTALL_CHATBOT_COMPLETED":false,
"COMPLETE_INFO_VISITED":false,
"COMPLETE_INFO_COMPLETED":false
},
"shouldFireScriptPixel":false,
"affiliateProgramCode":"neolo",
"marketingCampaignsInfo":{
},
"hashId":"909336c576d5cfd1a24feb7a8029a4a0517fd83acb587bfebac4f7a8d3941e74",
"isMercadoPago1":false
},
"errorDescription":"ERROR: java.lang.Exception: Error al enviar webhook. Status 400...",
"errorType":"ERROR_SHIPPING",
"lastIntegrationDate":"Jan 23, 2019 7:40:23 PM",
"nextRetry":"Jan 23, 2019 7:40:23 PM",
"retries":0
}]
 

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu ferme.

1. First Step

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent nec massa tristique arcu fermentum dapibus. Integer orci turpis, mollis vel augue eget, placerat rhoncus orci. Mauris metus libero, rutrum eu ornare ut, molestie vel nunc. Morbi sed iaculis metus.

Suggest Edits

/integrationContacts/:websiteId

Get first 50 integrations of contact for Website

 
get/contacts/integrations/:websiteId
curl --request GET \
  --url http://example.com/contacts/integrations/:websiteId
var request = require("request");

var options = { method: 'GET',
  url: 'http://example.com/contacts/integrations/:websiteId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://example.com/contacts/integrations/:websiteId")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://example.com/contacts/integrations/:websiteId");

xhr.send(data);
import requests

url = "http://example.com/contacts/integrations/:websiteId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[{
"id":"5c48c327e4b0db53b5d6b6d0",
"from":"CLIENGO",
"to":"WEBHOOK",
"status":"ERRORED",
"contact":{
"id":"5c48c327e4b0db53b5d6b6cb",
"accountId":"5c488c1be4b0db53b5d6b1cc",
"websiteId":"5c48c326e4b0db53b5d6b6c6",
"status":"new",
"name":"contact5",
"email":"contact5@gmail.com",
"phone":"1122334455",
"creationDate":"2019-01-23T19:40:23.091Z",
"lastUpdateDate":"Jan 23, 2019 7:40:23 PM",
"lastName":"",
"ip":"ip1",
"referalUrl":"rt1",
"landingUrl":"rt1",
"conversionUrl":"referer1",
"message":"hola amea",
"geoip":{
},
"duplicatedContact":false,
"notes":[
],
"medium":"referral",
"source":"rt1",
"mediumTranslate":"Referencia",
"sourceTranslate":"rt1",
"rating":2,
"utmSource":"rt1",
"utmMedium":"referral",
"utmCampaign":"",
"utmContent":"",
"utmTerm":"",
"accountName":"Leadaki (test env)",
"websiteName":"demoWeb"
},
"website":{
"id":"5c48c326e4b0db53b5d6b6c6",
"url":"www.demoweb.com",
"creationDate":"2019-01-23T19:40:22.794Z",
"email":"false@gmail.com",
"companyId":"5c488c1be4b0db53b5d6b1cc",
"title":"demoWeb",
"type":"WEBSITE",
"enableChat":true,
"labs":{
},
"deleted":false,
"availableSmartTriggers":[
{
"name":"all",
"value":"GLOBAL"
}
]
},
"company":{
"id":"5c488c1be4b0db53b5d6b1cc",
"email":"marianoyepes@gmail.com",
"phone":"+541133261336",
"name":"Leadaki (test env)",
"contactName":"Leadaki (test env)",
"creationDate":"Jan 23, 2019 3:45:31 PM",
"whiteLabelId":"5c488c1be4b0db53b5d6b1ca",
"whiteLabelName":"Whitelabel Leadaki",
"isCliengoReseller":false,
"whiteLabelLogoUrl":"https://res.cloudinary.com/hbrrdozyj/image/upload/v1435333518/leadaki_220_50_yuodjx.png",
"taxIdName":"Leadaki (test env)",
"leadCount":10,
"leadLimit":0,
"language":"en",
"timeZone":"-3:00",
"leadResetDate":"Feb 22, 2019 3:45:31 PM",
"daysToLeadResetDate":30,
"planCurrency":"USD",
"planName":"",
"labs":{
},
"chatUrl":"ws://localhost:9008",
"hasSubscription":false,
"forceChargebee":false,
"forceMercadoPago":false,
"quickstartSteps":{
"CREATE_ACCOUNT_COMPLETED":true,
"CHOOSE_APPEARANCE_VISITED":false,
"CHOOSE_APPEARANCE_COMPLETED":false,
"CUSTOMIZE_CONVERSATION_VISITED":false,
"CUSTOMIZE_CONVERSATION_COMPLETED":false,
"CREATE_AUTOMATIC_REPLY_VISITED":false,
"CREATE_AUTOMATIC_REPLY_COMPLETED":false,
"INSTALL_CHATBOT_VISITED":false,
"INSTALL_CHATBOT_COMPLETED":false,
"COMPLETE_INFO_VISITED":false,
"COMPLETE_INFO_COMPLETED":false
},
"shouldFireScriptPixel":false,
"affiliateProgramCode":"neolo",
"marketingCampaignsInfo":{
},
"hashId":"909336c576d5cfd1a24feb7a8029a4a0517fd83acb587bfebac4f7a8d3941e74",
"isMercadoPago1":false
},
"errorDescription":"ERROR: java.lang.Exception: Error al enviar webhook. Status 400...",
"errorType":"ERROR_SHIPPING",
"lastIntegrationDate":"Jan 23, 2019 7:40:23 PM",
"nextRetry":"Jan 23, 2019 7:40:23 PM",
"retries":0
}]
 
Suggest Edits

/integrationContacts/:integrationId/retryNow

Permit retry the integration

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
patchhttps://api.cliengo.com/1.0/contacts/integrations/:integrationId/retryNow
curl --request PATCH \
  --url https://api.cliengo.com/1.0/contacts/integrations/:integrationId/retryNow
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.cliengo.com/1.0/contacts/integrations/:integrationId/retryNow' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.cliengo.com/1.0/contacts/integrations/:integrationId/retryNow")

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

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.cliengo.com/1.0/contacts/integrations/:integrationId/retryNow");

xhr.send(data);
import requests

url = "https://api.cliengo.com/1.0/contacts/integrations/:integrationId/retryNow"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

/users

Gets all users for your company.

If you have no permissions to view other users in your company, you will be returned a JSON with just your own user.

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/users
curl "https://api.cliengo.com/1.0/users/?api_key={your_api_key}"
A binary file was returned

You couldn't be authenticated

{
  results: [
    {
      name: "Yepes",
      email: "marianoyepes@gmail.com",
      privileges:"basic,clients_read,clients_write",
      creationDate: "2012-11-25T00:00:00.000-03:00",
      id: "525ee44a44aea092fc6f75d4"
    },
    {
      name: "Mario",
      email: "mariomarian@dinahuapi.com",
      privileges: "",
      creationDate: "2015-07-28T15:23:42.457-03:00",
      id: "55b7c8aed4c651f76bbd1b49"
    }
],
size: 9
}
 
Suggest Edits

/users

Creates user and returns JSON with data of the created user.

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.cliengo.com/1.0/users
curl -X POST 'https://api.cliengo.com/1.0/users' --data "email=john@doe.com&name=John Doe&password="johndoerocks&api_key=YOURAPIKEY"
A binary file was returned

You couldn't be authenticated

{
  name: "John Doe",
  email: "john@doe.com",
  privileges: "",
  creationDate: "2015-07-28T15:48:43.000-03:00",
  id: "55b7ce8bd4c651f76bbd1b4b"
}

Body Params

email
string
required

Email for the user

password
string
required

Password for the user

name
string

Name of the user

phone
string

Phone of the user

privileges
array of strings

Scroll down for more info.

 

For security reasons, the user password isn't returned in the JSON.

User Privileges

User privileges define what a user can edit inside the CRM and the API. You can define them by sending them separated with commas, no spaces in between.

Example:

clients_write,clients_read,users_read

The set of privileges on the example would let the new user to be able to:

  • See clients within the company.
  • Create and edit clients within the company.
  • Only be able to see the users within the company, but not editing them.

There are two types of privileges, write and read. The read privilege, grants reading permissions. The write privilege will let the user edit and create X field.

You can see the list of privileges below:

Privilege
Description

clients_read

Grants read permissions for clients within the company.

clients_write

Grants writing permissions for clients within the company.

clients_read_assigned

The user will only be able to read clients assigned to them.

clients_write_assigned

The user will only be able to write clients assigned to them.

website_read

Grants read permissions for websites within the company.

website_write

Grants write permissions for websites within the company.

stats_read

Grants read permissions for stats within the company.

appointments_read

Grants read permissions for appointments within the company.

appointments_write

Grants write permissions for appointments within the company.

users_read

Grants read permissions for users within the company.

users_write

Grants write permissions for users within the company.

Suggest Edits

/users/:userId

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/users/userId
curl 'https://api.cliengo.com/1.0/users/55b7e7dbd4c62a298ff3fabc?api_key={your_api_key}' 
A binary file was returned

You couldn't be authenticated

{
  name: "John Doe",
  email: "john@doe.com",
  privileges: "",
  creationDate: "2015-07-28T17:36:43.646-03:00",
  id: "55b7e7dbd4c62a298ff3fabc"
}

Path Params

userId
string
required

User ID

 
Suggest Edits

/users/:userId

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
puthttps://api.cliengo.com/1.0/users/userId
curl -X PUT 'https://api.cliengo.com/1.0/users/55b7e7dbd4c62a298ff3fabc' --data "email=john@doerino.com&name=John Doerino&api_key=YOURAPIKEY"
A binary file was returned

You couldn't be authenticated

{
  name: "John Doerino",
  email: "john@doerino.com",
  privileges: "",
  creationDate: "2015-07-28T17:36:43.646-03:00",
  id: "55b7e7dbd4c62a298ff3fabc"
}

Path Params

userId
string
required

ID of the User.

Body Params

privileges
string

Scroll down for information about privileges.

email
string
name
string
password
string
phone
string
 

User Privileges

User privileges define what a user can edit inside the CRM and the API. You can define them by sending them separated with commas, no spaces in between.

Example:

clients_write,clients_read,users_read

The set of privileges on the example would let the new user to be able to:

  • See clients within the company.
  • Create and edit clients within the company.
  • Only be able to see the users within the company, but not editing them.

There are two types of privileges, write and read. The read privilege, grants reading permissions. The write privilege will let the user edit and create X field.

You can see the list of privileges below:

Privilege
Description

clients_read

Grants read permissions for clients within the company.

clients_write

Grants writing permissions for clients within the company.

clients_read_assigned

The user will only be able to read clients assigned to them.

clients_write_assigned

The user will only be able to write clients assigned to them.

website_read

Grants read permissions for websites within the company.

website_write

Grants write permissions for websites within the company.

stats_read

Grants read permissions for stats within the company.

appointments_read

Grants read permissions for appointments within the company.

appointments_write

Grants write permissions for appointments within the company.

users_read

Grants read permissions for users within the company.

users_write

Grants write permissions for users within the company.

Suggest Edits

/conversations

Get all conversations

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/conversations
curl "https://api.cliengo.com/1.0/conversations?api_key={your_api_key}"
A binary file was returned

You couldn't be authenticated

[{
  id: "55b7d5700364dfc80124b69d",
  lastMessage: "Sí, dale!",
  creationDate: "2015-07-28T16:18:08.215-03:00",
  participants : [
    {
      id: "userId_1",
     	type:"user"
    },
    {
      id: "robotID",
     	type:"robot"
    },
    {
      id: "0.31676287087611854@leadaki-chats.com",
     	type:"visitor"
    }
  ],
  contactId: "55dfasdf3452364237235", //se crea cuando el visitante deja sus datos
  websiteId: "3452346a8ns8hn1864224",
  totalUnreadMessages: 0,
},
{
  id: "55b7d5700343523623134",
  lastMessage: "No, dale!",
  creationDate: "2015-07-28T16:18:08.215-03:00",
  participants : [
    {
      id: "userId_1",
     	type:"user"
    },
    {
      id: "robotID",
     	type:"robot"
    },
    {
      id: "0.31676287087611854@leadaki-chats.com",
     	type:"visitor"
    }
  ],
  contactId: "55dfasdf87Y7dtastasd", //se crea cuando el visitante deja sus datos
  websiteId: "128123asha8ns8hn18",
  totalUnreadMessages: 0,
}]

Query Params

websiteId
string

Filter conversations received in this websiteId

status
string

The conversations status. Posible values are: new, active, long_term and client

offset
string

You can move the lower limit of the result block (Default is 0)

limit
string

To reduce the page size you can change the limit parameter (Default is 25)

 

You can retrieve all Conversations you have in Cliengo CRM.

Suggest Edits

/conversations/:websiteId/create

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.cliengo.com/1.0/conversationId/websiteId/create
curl "https://api.cliengo.com/1.0/conversations/{websiteId}/message?api_key={your_api_key}"
A binary file was returned

You couldn't be authenticated

{
		"paging": {
		"total": 2
		}
  	"results": [2]
        0:  {
            "conversationId": "566ac57203640db344531742"
            "id": "566ac57203640db344531743"
            "type": "models.chat.MessageText"
            "body": "esto es un mensaje de bienvenida!"
            "sender": {
                "id": "4323643262346234@leadaki.com"
                "type": "models.User"
           	}
          }
        1:  {
            "conversationId": "566ac57203640db344531742"
            "id": "566ac58503640db344531744"
            "type": "models.chat.MessageText"
            "body": "hola este es el mensaje"
            "sender": {
            		"id": "566ac56703640db34453171d"
            		"type": "models.User"
        		}
    		}
}

Path Params

websiteId
string
required

Body Params

from
string

Visitor description

message
string

Message text

 
Suggest Edits

/conversations/:conversationId

Get contact for ID

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/conversations/:conversationId
curl 'https://api.cliengo.com/1.0/conversations/{conversationsId}/?api_key={your_api_key}' 
A binary file was returned

You couldn't be authenticated

{
  id: "55b7d5700364dfc80124b69d",
  lastMessage: "Sí, dale!",
  creationDate: "2015-07-28T16:18:08.215-03:00",
  participants : [
    {
      id: "userId_1",
     	type:"user"
    },
    {
      id: "robotID",
     	type:"robot"
    },
    {
      id: "0.31676287087611854@leadaki-chats.com",
     	type:"visitor"
    }
  ],
  contactId: "55dfasdf87Y7dtastasd", //se crea cuando el visitante deja sus datos
  websiteId: "128123asha8ns8hn18",
  totalUnreadMessages: 0,
}

Query Params

conversationsID
string
required

ID Conversation

 
Suggest Edits

/conversations/:conversationId/messages

Get conversation messages

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/conversations/conversationId/messages
curl 'https://api.cliengo.com/1.0/conversations/{conversationId}/messages?api_key=TEST_API_KEY'
A binary file was returned

You couldn't be authenticated

{
  paging: {
    limit: 50,
    total: 2,
    offset: 0
  },
	results: [
    {
      id:"117bdasjasd9mj29jd100",
      type: "text/plain",
      body: "hola mundo!",
      sender: {
        id: "1234",
        type : "robot",
        name: null
      },
      sentAt: "2014-09-09T04:44:47+00:00",
      isUnread: true, //depende del user que esté consultando la API
    },
    {
      id: "117bdasjasd9mj29jd101",
      type: "text/plain",
      body: "hola mundo!",
      sender: {
        id: "1234",
        type : "robot",
        name: null
      },
      sentAt: "2014-09-09T04:44:47+00:00",
      isUnread: true, //depende del user que esté consultando la API
    }
	]
}

Path Params

conversationId
string
required

Id conversation

 
Suggest Edits

/conversations/:conversationId/messages/:messageId

Get conversation messages

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/conversations/:conversationId/messages/messageId
curl 'https://api.cliengo.com/1.0/conversations/{conversationId}/messages/{messageId}?api_key=TEST_API_KEY'
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

conversationsId
string
required

Id conversation

messageId
string
required
 

Message

{
  id: "117bdasjasd9mj29jd233",
  type: "text/plain",
  body: "hola mundo!",
	sender: {
    id: "1234",
    type : "robot",
    name: null
  },
	conversationId:"asd8bqwwdyqdqydqyasdas",
  sentAt: "2014-09-09T04:44:47+00:00",
  isUnread: true, //depende del user que esté consultando la API
  recipient_status: { //WIP
    "777": "sent",
    "111": "delivered",
    "999": "read",
    "1234": "read"
  }
}

URL visit

{
  type: "message/http",
  body: "http://www.cliengo.com/precios",
  ...
}

Audio

{
  type: "audio/mpeg",
  body: "http://www.cliengo.com/blaasdadadasd.mp3",
  ...
}

Email

{
  type: "email",
  body: "hola esto vino en un email!",
  ...
}
Suggest Edits

/conversations/:conversationId/message

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
puthttps://api.cliengo.com/1.0/conversations/conversationId/message
curl --request PUT \
  --url https://api.cliengo.com/1.0/conversations/conversationId/message
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.cliengo.com/1.0/conversations/conversationId/message' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.cliengo.com/1.0/conversations/conversationId/message")

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

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.cliengo.com/1.0/conversations/conversationId/message");

xhr.send(data);
import requests

url = "https://api.cliengo.com/1.0/conversations/conversationId/message"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

conversationId
string
required

Body Params

message
string
type
string
from
string
fromType
string
 
Suggest Edits

/conversations/:websiteId/count

Retrieves the total amount o conversations for the company

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/conversations/websiteId/count
curl --request GET \
  --url https://api.cliengo.com/1.0/conversations/websiteId/count
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.cliengo.com/1.0/conversations/websiteId/count' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.cliengo.com/1.0/conversations/websiteId/count")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.cliengo.com/1.0/conversations/websiteId/count");

xhr.send(data);
import requests

url = "https://api.cliengo.com/1.0/conversations/websiteId/count"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  count: 1200
}
{
  error: "bad-request"
}

Path Params

websiteId
string
required
 

Retrieves the total amount o conversations for the company

This endpoint is under development

Suggest Edits

/process/:websiteId/chatbot-triggers

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/process/websiteId/chatbot-triggers
curl 'https://api.cliengo.com/1.0/process/{websiteId}/messages/chatbot-triggers?text=do you deliver on weekends&api_key=TEST_API_KEY'
A binary file was returned

You couldn't be authenticated

[
  {
    "response": "sure!, this is a triggered response and we deliver on weekends!",
    "stopNextMessage": false,
    "ignoreLead": false,
    "matches": [
      {
        "type": "CONTAINS",
        "value": "weekends"
      }
    ]
  }
]

Path Params

websiteId
string
required

Query Params

text
string
required

Text to match with triggers for this websiteId's chatbot

 
Suggest Edits

/adwords/uploadOfflineConvertion

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/adwords/uploadOfflineConvertion
curl 'https://api.cliengo.com/1.0/adwords/uploadOfflineConvertion?gclid={your_gclid}&api_key={your_api_key}'
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

gclid
string
required

Google AdWords Click ID

websiteId
string

(Optional) In case you have Leadaki's websiteId

convertionName
string

(Optional) If sent, this MUST match an offline convertion list already defined in the AdWords Account related to the gclid.

 

Post an offline convertion to Google AdWords vía Cliengo API. You need the parameter "gclid" that is the unique identifier that Google gives to every click made in AdWords.

Suggest Edits

/plans/:planId

Retrieve a subscription plans for Cliengo by planId

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/plans/planId
curl --request GET \
  --url https://api.cliengo.com/1.0/plans/planId
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.cliengo.com/1.0/plans/planId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.cliengo.com/1.0/plans/planId")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.cliengo.com/1.0/plans/planId");

xhr.send(data);
import requests

url = "https://api.cliengo.com/1.0/plans/planId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "CLIENGO_BASIC",
  "name": "Cliengo Básico",
  "leadLimit": 100,
  "websiteLimit": 2,
  "userLimit": 3,
  "description": "Cliengo básico, 100 leads por mes",
  "priceARS": 450,
  "priceUSD": 29.0,
  "integrationsAllowed": true,
  "imageUrl": "https://res.cloudinary.com/hbrrdozyj/image/upload/v1484836411/plan_basic_afyhbl.png"
}

Path Params

planId
string
required

Current available values are: CLIENGO_FREE, CLIENGO_BASIC, CLIENGO_FULL, CLIENGO_PROFESSIONAL, CLIENGO_CUSTOM

 
Suggest Edits

/plans

Retrieve the different subscriptions plans for Cliengo

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
gethttps://api.cliengo.com/1.0/plans
curl --request GET \
  --url https://api.cliengo.com/1.0/plans
var request = require("request");

var options = { method: 'GET', url: 'https://api.cliengo.com/1.0/plans' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.cliengo.com/1.0/plans")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.cliengo.com/1.0/plans");

xhr.send(data);
import requests

url = "https://api.cliengo.com/1.0/plans"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "paging": {
    "total": 2
  },
  "results": [
   {
      "id": "CLIENGO_BASIC",
      "name": "Cliengo Básico",
      "description": "Cliengo básico, 100 leads por mes",
      "leadLimit": 100,
      "websiteLimit": 2,
      "userLimit": 3,
      "priceUSD": 29.0,
      "priceARS": 450,
      "integrationsAllowed": true,
      "imageUrl": "https://res.cloudinary.com/hbrrdozyj/image/upload/v1484836411/plan_basic_afyhbl.png"
    },
    {
      "id": "CLIENGO_PROFESSIONAL",
      "name": "Cliengo Profesional",
      "description": "Cliengo profesional, 400 leads por mes.",
      "leadLimit": 400,
      "websiteLimit": 3,
      "userLimit": 5,
      "priceUSD": 79.0,
      "priceARS": 1190,
      "integrationsAllowed": true,
      "imageUrl": "https://res.cloudinary.com/hbrrdozyj/image/upload/v1484836411/plan_professional_fzztlz.png"
    }
  ]
}
 
Suggest Edits

/contacts/:id/feedback

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
posthttps://api.cliengo.com/1.0/contacts/:id/feedback
curl --request POST \
  --url https://api.cliengo.com/1.0/contacts/:id/feedback
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.cliengo.com/1.0/contacts/:id/feedback' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.cliengo.com/1.0/contacts/:id/feedback")

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

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.cliengo.com/1.0/contacts/:id/feedback");

xhr.send(data);
import requests

url = "https://api.cliengo.com/1.0/contacts/:id/feedback"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

wasContacted
boolean
required

Si el lead fue/no fue contactado

contact_access_token
string
required

Contact Id hashed with SHA512

 
Suggest Edits

/contacts/:id/feedback

 

Query Auth

Header Auth

 Authentication is required for this endpoint.
puthttps://api.cliengo.com/1.0/contacts/:id/feedback
curl --request PUT \
  --url https://api.cliengo.com/1.0/contacts/:id/feedback
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.cliengo.com/1.0/contacts/:id/feedback' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.cliengo.com/1.0/contacts/:id/feedback")

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

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.cliengo.com/1.0/contacts/:id/feedback");

xhr.send(data);
import requests

url = "https://api.cliengo.com/1.0/contacts/:id/feedback"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

contact_access_token
string
required

Contact ID hashed with SHA512

comment
string
required

Leads comment on the web form

time
string
required

Leads specified time to be contacted

phone
string
required

Leads phone number

interested
boolean
required

Boolean specifying if the lead is interested in further communications