Create a lead
curl --request POST \
--url https://api.linkiasoft.com/api/v1/leads \
--header 'Content-Type: application/json' \
--header 'X-Tenant-Id: <api-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"company_name": "<string>",
"status": "<string>",
"industry": "<string>",
"source": "<string>",
"assigned_to_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"probability": 123,
"value": 123,
"currency": "<string>",
"expected_close_date": "2023-12-25",
"tags": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://api.linkiasoft.com/api/v1/leads"
payload = {
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"company_name": "<string>",
"status": "<string>",
"industry": "<string>",
"source": "<string>",
"assigned_to_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"probability": 123,
"value": 123,
"currency": "<string>",
"expected_close_date": "2023-12-25",
"tags": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"x-api-key": "<api-key>",
"X-Tenant-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'X-Tenant-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
email: '<string>',
phone: '<string>',
company_name: '<string>',
status: '<string>',
industry: '<string>',
source: '<string>',
assigned_to_user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
probability: 123,
value: 123,
currency: '<string>',
expected_close_date: '2023-12-25',
tags: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://api.linkiasoft.com/api/v1/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.linkiasoft.com/api/v1/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([
'name' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'company_name' => '<string>',
'status' => '<string>',
'industry' => '<string>',
'source' => '<string>',
'assigned_to_user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'probability' => 123,
'value' => 123,
'currency' => '<string>',
'expected_close_date' => '2023-12-25',
'tags' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Tenant-Id: <api-key>",
"x-api-key: <api-key>"
],
]);
$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.linkiasoft.com/api/v1/leads"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"company_name\": \"<string>\",\n \"status\": \"<string>\",\n \"industry\": \"<string>\",\n \"source\": \"<string>\",\n \"assigned_to_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"probability\": 123,\n \"value\": 123,\n \"currency\": \"<string>\",\n \"expected_close_date\": \"2023-12-25\",\n \"tags\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("X-Tenant-Id", "<api-key>")
req.Header.Add("Content-Type", "application/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.linkiasoft.com/api/v1/leads")
.header("x-api-key", "<api-key>")
.header("X-Tenant-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"company_name\": \"<string>\",\n \"status\": \"<string>\",\n \"industry\": \"<string>\",\n \"source\": \"<string>\",\n \"assigned_to_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"probability\": 123,\n \"value\": 123,\n \"currency\": \"<string>\",\n \"expected_close_date\": \"2023-12-25\",\n \"tags\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.linkiasoft.com/api/v1/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["X-Tenant-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"company_name\": \"<string>\",\n \"status\": \"<string>\",\n \"industry\": \"<string>\",\n \"source\": \"<string>\",\n \"assigned_to_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"probability\": 123,\n \"value\": 123,\n \"currency\": \"<string>\",\n \"expected_close_date\": \"2023-12-25\",\n \"tags\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"company_name": "<string>",
"status": "<string>",
"customer_type": "individual",
"industry": "<string>",
"source": "<string>",
"assigned_to_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"priority": "urgent",
"probability": 123,
"value": 123,
"currency": "<string>",
"expected_close_date": "2023-12-25",
"tags": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"statusCode": 403,
"message": "API key missing required scope(s): conversations:read",
"error": "Forbidden"
}{
"statusCode": 403,
"message": "API key missing required scope(s): conversations:read",
"error": "Forbidden"
}{
"statusCode": 403,
"message": "API key missing required scope(s): conversations:read",
"error": "Forbidden"
}Leads
Create a lead
POST
/
v1
/
leads
Create a lead
curl --request POST \
--url https://api.linkiasoft.com/api/v1/leads \
--header 'Content-Type: application/json' \
--header 'X-Tenant-Id: <api-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"company_name": "<string>",
"status": "<string>",
"industry": "<string>",
"source": "<string>",
"assigned_to_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"probability": 123,
"value": 123,
"currency": "<string>",
"expected_close_date": "2023-12-25",
"tags": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://api.linkiasoft.com/api/v1/leads"
payload = {
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"company_name": "<string>",
"status": "<string>",
"industry": "<string>",
"source": "<string>",
"assigned_to_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"probability": 123,
"value": 123,
"currency": "<string>",
"expected_close_date": "2023-12-25",
"tags": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"x-api-key": "<api-key>",
"X-Tenant-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'X-Tenant-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
email: '<string>',
phone: '<string>',
company_name: '<string>',
status: '<string>',
industry: '<string>',
source: '<string>',
assigned_to_user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
probability: 123,
value: 123,
currency: '<string>',
expected_close_date: '2023-12-25',
tags: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://api.linkiasoft.com/api/v1/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.linkiasoft.com/api/v1/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([
'name' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'company_name' => '<string>',
'status' => '<string>',
'industry' => '<string>',
'source' => '<string>',
'assigned_to_user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'probability' => 123,
'value' => 123,
'currency' => '<string>',
'expected_close_date' => '2023-12-25',
'tags' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Tenant-Id: <api-key>",
"x-api-key: <api-key>"
],
]);
$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.linkiasoft.com/api/v1/leads"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"company_name\": \"<string>\",\n \"status\": \"<string>\",\n \"industry\": \"<string>\",\n \"source\": \"<string>\",\n \"assigned_to_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"probability\": 123,\n \"value\": 123,\n \"currency\": \"<string>\",\n \"expected_close_date\": \"2023-12-25\",\n \"tags\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("X-Tenant-Id", "<api-key>")
req.Header.Add("Content-Type", "application/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.linkiasoft.com/api/v1/leads")
.header("x-api-key", "<api-key>")
.header("X-Tenant-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"company_name\": \"<string>\",\n \"status\": \"<string>\",\n \"industry\": \"<string>\",\n \"source\": \"<string>\",\n \"assigned_to_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"probability\": 123,\n \"value\": 123,\n \"currency\": \"<string>\",\n \"expected_close_date\": \"2023-12-25\",\n \"tags\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.linkiasoft.com/api/v1/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["X-Tenant-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"company_name\": \"<string>\",\n \"status\": \"<string>\",\n \"industry\": \"<string>\",\n \"source\": \"<string>\",\n \"assigned_to_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"probability\": 123,\n \"value\": 123,\n \"currency\": \"<string>\",\n \"expected_close_date\": \"2023-12-25\",\n \"tags\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"company_name": "<string>",
"status": "<string>",
"customer_type": "individual",
"industry": "<string>",
"source": "<string>",
"assigned_to_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"priority": "urgent",
"probability": 123,
"value": 123,
"currency": "<string>",
"expected_close_date": "2023-12-25",
"tags": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"statusCode": 403,
"message": "API key missing required scope(s): conversations:read",
"error": "Forbidden"
}{
"statusCode": 403,
"message": "API key missing required scope(s): conversations:read",
"error": "Forbidden"
}{
"statusCode": 403,
"message": "API key missing required scope(s): conversations:read",
"error": "Forbidden"
}Authorizations
Your workspace API key. Create one in Settings → API Keys; the plaintext value is shown once and never again.
Keys are scoped. A key needs conversations:send to send, conversations:read to
read threads and messages, templates:read to list templates, and channels:read
to list channels. A key missing the scope for an endpoint gets 403.
The CRM endpoints use the same resource:action form: leads:read, leads:create,
leads:update, leads:delete, customers:read, customers:create,
customers:update, customers:delete, customers:manage.
Several resources have no scope of their own and borrow one:
| Resource | Governed by |
|---|---|
| Contacts | customers:* |
| Activities | customers:* for customer activities, leads:* for lead activities |
| Tags | customers:read to list, customers:manage to change |
| Pipeline stages | leads:* |
| Quick replies | quick-replies:read / quick-replies:write |
| WhatsApp groups | wa-groups:manage |
Grant only what the integration needs — a key that only sends notifications should
hold conversations:send and nothing else.
Your workspace UUID. Required on every request in addition to x-api-key.
It does not select the workspace — data access is always scoped to the workspace that owns the API key, and a mismatched value cannot read anyone else's data.
Body
application/json
All fields optional on update; send only what changes.
Target stage key.
Available options:
individual, business Available options:
urgent, high, medium, low Response
The created lead.
The lead's stage key — see GET /v1/lead-stages.
Available options:
individual, business Where the lead came from, e.g. whatsapp or website.
Available options:
urgent, high, medium, low Percentage, 0–100.
Deal size.