Create a deal
curl --request POST \
--url https://n-api.leadstaker.com/v1/deals \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"contactId": "<string>",
"fields": [
{
"fieldId": "<string>",
"value": "<unknown>"
}
],
"pipelineId": "<string>",
"stageId": "<string>",
"lossReasonId": "<string>",
"tagIds": [
"<string>"
]
}
'import requests
url = "https://n-api.leadstaker.com/v1/deals"
payload = {
"contactId": "<string>",
"fields": [
{
"fieldId": "<string>",
"value": "<unknown>"
}
],
"pipelineId": "<string>",
"stageId": "<string>",
"lossReasonId": "<string>",
"tagIds": ["<string>"]
}
headers = {
"x-api-key": "<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>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '<string>',
fields: [{fieldId: '<string>', value: '<unknown>'}],
pipelineId: '<string>',
stageId: '<string>',
lossReasonId: '<string>',
tagIds: ['<string>']
})
};
fetch('https://n-api.leadstaker.com/v1/deals', 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://n-api.leadstaker.com/v1/deals",
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([
'contactId' => '<string>',
'fields' => [
[
'fieldId' => '<string>',
'value' => '<unknown>'
]
],
'pipelineId' => '<string>',
'stageId' => '<string>',
'lossReasonId' => '<string>',
'tagIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://n-api.leadstaker.com/v1/deals"
payload := strings.NewReader("{\n \"contactId\": \"<string>\",\n \"fields\": [\n {\n \"fieldId\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"pipelineId\": \"<string>\",\n \"stageId\": \"<string>\",\n \"lossReasonId\": \"<string>\",\n \"tagIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://n-api.leadstaker.com/v1/deals")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contactId\": \"<string>\",\n \"fields\": [\n {\n \"fieldId\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"pipelineId\": \"<string>\",\n \"stageId\": \"<string>\",\n \"lossReasonId\": \"<string>\",\n \"tagIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://n-api.leadstaker.com/v1/deals")
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["Content-Type"] = 'application/json'
request.body = "{\n \"contactId\": \"<string>\",\n \"fields\": [\n {\n \"fieldId\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"pipelineId\": \"<string>\",\n \"stageId\": \"<string>\",\n \"lossReasonId\": \"<string>\",\n \"tagIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "6715be3a9c40aa0013d8e5c2",
"projectId": "665f1c2e8a94b70012d4e9a1",
"contactId": "6712a4d95b38ee0011c9f2b4",
"fields": [
{
"fieldId": "66eab3c47d21ff0011b2d6ea",
"value": 1200
}
],
"tagIds": [
"67102f6c3e85dd0012f5b8c3"
],
"responsibleId": "664d9e0b7c83aa0010f1c2d3",
"pipelineId": "670fa8b21d94cc0010e3c7a5",
"stageId": "670fa8b21d94cc0010e3c7a8",
"stageEnteredAt": "2026-01-14T11:20:00.000Z",
"createdAt": "2026-01-12T14:08:00.000Z",
"updatedAt": "2026-01-15T09:32:00.000Z"
}{
"errorCode": "<string>",
"message": "<string>",
"status": 123,
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"errorCode": "<string>",
"message": "<string>",
"status": 123,
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}Deals
Create a deal
Creates the deal in the project of the API key and answers 201 with the created record.
POST
/
v1
/
deals
Create a deal
curl --request POST \
--url https://n-api.leadstaker.com/v1/deals \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"contactId": "<string>",
"fields": [
{
"fieldId": "<string>",
"value": "<unknown>"
}
],
"pipelineId": "<string>",
"stageId": "<string>",
"lossReasonId": "<string>",
"tagIds": [
"<string>"
]
}
'import requests
url = "https://n-api.leadstaker.com/v1/deals"
payload = {
"contactId": "<string>",
"fields": [
{
"fieldId": "<string>",
"value": "<unknown>"
}
],
"pipelineId": "<string>",
"stageId": "<string>",
"lossReasonId": "<string>",
"tagIds": ["<string>"]
}
headers = {
"x-api-key": "<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>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '<string>',
fields: [{fieldId: '<string>', value: '<unknown>'}],
pipelineId: '<string>',
stageId: '<string>',
lossReasonId: '<string>',
tagIds: ['<string>']
})
};
fetch('https://n-api.leadstaker.com/v1/deals', 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://n-api.leadstaker.com/v1/deals",
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([
'contactId' => '<string>',
'fields' => [
[
'fieldId' => '<string>',
'value' => '<unknown>'
]
],
'pipelineId' => '<string>',
'stageId' => '<string>',
'lossReasonId' => '<string>',
'tagIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://n-api.leadstaker.com/v1/deals"
payload := strings.NewReader("{\n \"contactId\": \"<string>\",\n \"fields\": [\n {\n \"fieldId\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"pipelineId\": \"<string>\",\n \"stageId\": \"<string>\",\n \"lossReasonId\": \"<string>\",\n \"tagIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://n-api.leadstaker.com/v1/deals")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contactId\": \"<string>\",\n \"fields\": [\n {\n \"fieldId\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"pipelineId\": \"<string>\",\n \"stageId\": \"<string>\",\n \"lossReasonId\": \"<string>\",\n \"tagIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://n-api.leadstaker.com/v1/deals")
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["Content-Type"] = 'application/json'
request.body = "{\n \"contactId\": \"<string>\",\n \"fields\": [\n {\n \"fieldId\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"pipelineId\": \"<string>\",\n \"stageId\": \"<string>\",\n \"lossReasonId\": \"<string>\",\n \"tagIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "6715be3a9c40aa0013d8e5c2",
"projectId": "665f1c2e8a94b70012d4e9a1",
"contactId": "6712a4d95b38ee0011c9f2b4",
"fields": [
{
"fieldId": "66eab3c47d21ff0011b2d6ea",
"value": 1200
}
],
"tagIds": [
"67102f6c3e85dd0012f5b8c3"
],
"responsibleId": "664d9e0b7c83aa0010f1c2d3",
"pipelineId": "670fa8b21d94cc0010e3c7a5",
"stageId": "670fa8b21d94cc0010e3c7a8",
"stageEnteredAt": "2026-01-14T11:20:00.000Z",
"createdAt": "2026-01-12T14:08:00.000Z",
"updatedAt": "2026-01-15T09:32:00.000Z"
}{
"errorCode": "<string>",
"message": "<string>",
"status": 123,
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"errorCode": "<string>",
"message": "<string>",
"status": 123,
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}Authorizations
Body
application/json
Response
Success
Minimum string length:
1Minimum string length:
1Minimum string length:
1Show child attributes
Show child attributes
Minimum string length:
1Minimum string length:
1Minimum string length:
1Minimum string length:
1Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I