Create a field
curl --request POST \
--url https://n-api.leadstaker.com/v1/fields \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"label": "<string>",
"type": "TEXT",
"fieldGroupId": "<string>",
"config": {},
"position": 1,
"level": "USER"
}
'import requests
url = "https://n-api.leadstaker.com/v1/fields"
payload = {
"label": "<string>",
"type": "TEXT",
"fieldGroupId": "<string>",
"config": {},
"position": 1,
"level": "USER"
}
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({
label: '<string>',
type: 'TEXT',
fieldGroupId: '<string>',
config: {},
position: 1,
level: 'USER'
})
};
fetch('https://n-api.leadstaker.com/v1/fields', 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/fields",
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([
'label' => '<string>',
'type' => 'TEXT',
'fieldGroupId' => '<string>',
'config' => [
],
'position' => 1,
'level' => 'USER'
]),
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/fields"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"type\": \"TEXT\",\n \"fieldGroupId\": \"<string>\",\n \"config\": {},\n \"position\": 1,\n \"level\": \"USER\"\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/fields")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"type\": \"TEXT\",\n \"fieldGroupId\": \"<string>\",\n \"config\": {},\n \"position\": 1,\n \"level\": \"USER\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://n-api.leadstaker.com/v1/fields")
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 \"label\": \"<string>\",\n \"type\": \"TEXT\",\n \"fieldGroupId\": \"<string>\",\n \"config\": {},\n \"position\": 1,\n \"level\": \"USER\"\n}"
response = http.request(request)
puts response.read_body{
"id": "66eab3c47d21ff0011b2d6e8",
"entityType": "CONTACT",
"label": "Nome",
"type": "TEXT",
"config": {},
"position": 0,
"level": "USER",
"fieldGroupId": "66eab3c47d21ff0011b2d6f0",
"projectId": "665f1c2e8a94b70012d4e9a1",
"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>"
}
]
}Fields
Create a field
Creates the field in the project of the API key and answers 201 with the created record.
POST
/
v1
/
fields
Create a field
curl --request POST \
--url https://n-api.leadstaker.com/v1/fields \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"label": "<string>",
"type": "TEXT",
"fieldGroupId": "<string>",
"config": {},
"position": 1,
"level": "USER"
}
'import requests
url = "https://n-api.leadstaker.com/v1/fields"
payload = {
"label": "<string>",
"type": "TEXT",
"fieldGroupId": "<string>",
"config": {},
"position": 1,
"level": "USER"
}
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({
label: '<string>',
type: 'TEXT',
fieldGroupId: '<string>',
config: {},
position: 1,
level: 'USER'
})
};
fetch('https://n-api.leadstaker.com/v1/fields', 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/fields",
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([
'label' => '<string>',
'type' => 'TEXT',
'fieldGroupId' => '<string>',
'config' => [
],
'position' => 1,
'level' => 'USER'
]),
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/fields"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"type\": \"TEXT\",\n \"fieldGroupId\": \"<string>\",\n \"config\": {},\n \"position\": 1,\n \"level\": \"USER\"\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/fields")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"type\": \"TEXT\",\n \"fieldGroupId\": \"<string>\",\n \"config\": {},\n \"position\": 1,\n \"level\": \"USER\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://n-api.leadstaker.com/v1/fields")
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 \"label\": \"<string>\",\n \"type\": \"TEXT\",\n \"fieldGroupId\": \"<string>\",\n \"config\": {},\n \"position\": 1,\n \"level\": \"USER\"\n}"
response = http.request(request)
puts response.read_body{
"id": "66eab3c47d21ff0011b2d6e8",
"entityType": "CONTACT",
"label": "Nome",
"type": "TEXT",
"config": {},
"position": 0,
"level": "USER",
"fieldGroupId": "66eab3c47d21ff0011b2d6f0",
"projectId": "665f1c2e8a94b70012d4e9a1",
"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
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
Response
Success
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
Available options:
DEAL, CONTACT Minimum string length:
1Available options:
TEXT Available options:
USER, API Required range:
x >= 0Available options:
NAME, PHONE, EMAIL, PRICE, ACQUISITION_SOURCE, ORIGIN_URL, LEAD_ID, WHATSAPP_LID, CUSTOM_ID Minimum string length:
1⌘I