Leads
Create lead
Creates a new lead. When creating a lead, supply stage_name to assign the initial pipeline stage. Requires crm:write scope.
POST
/
leads
Create Lead
curl --request POST \
--url https://crm-api.automatebusiness.com/api/v1/integrations-public/leads \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Acme Corp Enterprise Deal",
"email": "lead@acmecorp.com",
"phone": "+15559876543",
"pipeline_id": "pipe_default",
"stage_name": "New Lead",
"assigned_to": "user_sarah",
"tags": [
"enterprise",
"inbound"
],
"custom_fields": {
"deal_value": 50000
},
"meta_attribution": {
"utm_source": "<string>",
"utm_medium": "<string>",
"utm_campaign": "<string>"
}
}
'import requests
url = "https://crm-api.automatebusiness.com/api/v1/integrations-public/leads"
payload = {
"name": "Acme Corp Enterprise Deal",
"email": "lead@acmecorp.com",
"phone": "+15559876543",
"pipeline_id": "pipe_default",
"stage_name": "New Lead",
"assigned_to": "user_sarah",
"tags": ["enterprise", "inbound"],
"custom_fields": { "deal_value": 50000 },
"meta_attribution": {
"utm_source": "<string>",
"utm_medium": "<string>",
"utm_campaign": "<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({
name: 'Acme Corp Enterprise Deal',
email: 'lead@acmecorp.com',
phone: '+15559876543',
pipeline_id: 'pipe_default',
stage_name: 'New Lead',
assigned_to: 'user_sarah',
tags: ['enterprise', 'inbound'],
custom_fields: {deal_value: 50000},
meta_attribution: {utm_source: '<string>', utm_medium: '<string>', utm_campaign: '<string>'}
})
};
fetch('https://crm-api.automatebusiness.com/api/v1/integrations-public/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://crm-api.automatebusiness.com/api/v1/integrations-public/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' => 'Acme Corp Enterprise Deal',
'email' => 'lead@acmecorp.com',
'phone' => '+15559876543',
'pipeline_id' => 'pipe_default',
'stage_name' => 'New Lead',
'assigned_to' => 'user_sarah',
'tags' => [
'enterprise',
'inbound'
],
'custom_fields' => [
'deal_value' => 50000
],
'meta_attribution' => [
'utm_source' => '<string>',
'utm_medium' => '<string>',
'utm_campaign' => '<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://crm-api.automatebusiness.com/api/v1/integrations-public/leads"
payload := strings.NewReader("{\n \"name\": \"Acme Corp Enterprise Deal\",\n \"email\": \"lead@acmecorp.com\",\n \"phone\": \"+15559876543\",\n \"pipeline_id\": \"pipe_default\",\n \"stage_name\": \"New Lead\",\n \"assigned_to\": \"user_sarah\",\n \"tags\": [\n \"enterprise\",\n \"inbound\"\n ],\n \"custom_fields\": {\n \"deal_value\": 50000\n },\n \"meta_attribution\": {\n \"utm_source\": \"<string>\",\n \"utm_medium\": \"<string>\",\n \"utm_campaign\": \"<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://crm-api.automatebusiness.com/api/v1/integrations-public/leads")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Corp Enterprise Deal\",\n \"email\": \"lead@acmecorp.com\",\n \"phone\": \"+15559876543\",\n \"pipeline_id\": \"pipe_default\",\n \"stage_name\": \"New Lead\",\n \"assigned_to\": \"user_sarah\",\n \"tags\": [\n \"enterprise\",\n \"inbound\"\n ],\n \"custom_fields\": {\n \"deal_value\": 50000\n },\n \"meta_attribution\": {\n \"utm_source\": \"<string>\",\n \"utm_medium\": \"<string>\",\n \"utm_campaign\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://crm-api.automatebusiness.com/api/v1/integrations-public/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["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Corp Enterprise Deal\",\n \"email\": \"lead@acmecorp.com\",\n \"phone\": \"+15559876543\",\n \"pipeline_id\": \"pipe_default\",\n \"stage_name\": \"New Lead\",\n \"assigned_to\": \"user_sarah\",\n \"tags\": [\n \"enterprise\",\n \"inbound\"\n ],\n \"custom_fields\": {\n \"deal_value\": 50000\n },\n \"meta_attribution\": {\n \"utm_source\": \"<string>\",\n \"utm_medium\": \"<string>\",\n \"utm_campaign\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "lead_890ef12a",
"name": "Acme Corp Enterprise Deal",
"email": "lead@acmecorp.com",
"phone": "+15559876543",
"pipeline_id": "pipe_default",
"stage_id": "stage_contacted",
"stage_name": "Contacted",
"assigned_to": "user_sarah",
"tags": [
"enterprise",
"q4-inbound"
],
"custom_fields": {
"deal_value": 50000,
"industry": "Technology"
},
"meta_attribution": {
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "fall_promo"
},
"created_at": "2026-10-26T09:30:00.000Z",
"updated_at": "2026-10-26T09:30:00.000Z"
},
"error": null
}{
"success": false,
"data": null,
"error": {
"message": "Validation failed",
"details": [
{
"message": "Required",
"field": "email",
"code": "invalid_type"
}
]
}
}{
"success": false,
"data": null,
"error": {
"message": "Invalid or missing API key."
}
}{
"success": false,
"data": null,
"error": {
"message": "Forbidden: insufficient permissions for this operation."
}
}{
"success": false,
"data": null,
"error": {
"message": "Conflict: resource with unique identifier already exists."
}
}Creates a new lead deal record in your workspace.
Stage assignment behavior
When creating a lead, supply the target stage name in thestage_name body field (for example, "stage_name": "New Lead").
Attribution and custom fields
You can pass Meta campaign attribution fields insidemeta_attribution (utm_source, utm_medium, utm_campaign) and custom field values defined for leads inside custom_fields.
Required permissions
Requires an API key with thecrm:write scope.Authorizations
Workspace API key header. The key implicitly determines your workspace isolation. Scopes: crm:read for GET/HEAD/OPTIONS, crm:write for POST/PATCH/PUT/DELETE.
Body
application/json
Lead title or organization name
Example:
"Acme Corp Enterprise Deal"
Example:
"lead@acmecorp.com"
Example:
"+15559876543"
Optional pipeline identifier; defaults to primary pipeline if omitted
Example:
"pipe_default"
Name of the target stage when creating the lead (e.g. 'New Lead', 'Qualified')
Example:
"New Lead"
Team member user ID
Example:
"user_sarah"
Example:
["enterprise", "inbound"]
Example:
{ "deal_value": 50000 }
Show child attributes
Show child attributes
⌘I
Create Lead
curl --request POST \
--url https://crm-api.automatebusiness.com/api/v1/integrations-public/leads \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Acme Corp Enterprise Deal",
"email": "lead@acmecorp.com",
"phone": "+15559876543",
"pipeline_id": "pipe_default",
"stage_name": "New Lead",
"assigned_to": "user_sarah",
"tags": [
"enterprise",
"inbound"
],
"custom_fields": {
"deal_value": 50000
},
"meta_attribution": {
"utm_source": "<string>",
"utm_medium": "<string>",
"utm_campaign": "<string>"
}
}
'import requests
url = "https://crm-api.automatebusiness.com/api/v1/integrations-public/leads"
payload = {
"name": "Acme Corp Enterprise Deal",
"email": "lead@acmecorp.com",
"phone": "+15559876543",
"pipeline_id": "pipe_default",
"stage_name": "New Lead",
"assigned_to": "user_sarah",
"tags": ["enterprise", "inbound"],
"custom_fields": { "deal_value": 50000 },
"meta_attribution": {
"utm_source": "<string>",
"utm_medium": "<string>",
"utm_campaign": "<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({
name: 'Acme Corp Enterprise Deal',
email: 'lead@acmecorp.com',
phone: '+15559876543',
pipeline_id: 'pipe_default',
stage_name: 'New Lead',
assigned_to: 'user_sarah',
tags: ['enterprise', 'inbound'],
custom_fields: {deal_value: 50000},
meta_attribution: {utm_source: '<string>', utm_medium: '<string>', utm_campaign: '<string>'}
})
};
fetch('https://crm-api.automatebusiness.com/api/v1/integrations-public/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://crm-api.automatebusiness.com/api/v1/integrations-public/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' => 'Acme Corp Enterprise Deal',
'email' => 'lead@acmecorp.com',
'phone' => '+15559876543',
'pipeline_id' => 'pipe_default',
'stage_name' => 'New Lead',
'assigned_to' => 'user_sarah',
'tags' => [
'enterprise',
'inbound'
],
'custom_fields' => [
'deal_value' => 50000
],
'meta_attribution' => [
'utm_source' => '<string>',
'utm_medium' => '<string>',
'utm_campaign' => '<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://crm-api.automatebusiness.com/api/v1/integrations-public/leads"
payload := strings.NewReader("{\n \"name\": \"Acme Corp Enterprise Deal\",\n \"email\": \"lead@acmecorp.com\",\n \"phone\": \"+15559876543\",\n \"pipeline_id\": \"pipe_default\",\n \"stage_name\": \"New Lead\",\n \"assigned_to\": \"user_sarah\",\n \"tags\": [\n \"enterprise\",\n \"inbound\"\n ],\n \"custom_fields\": {\n \"deal_value\": 50000\n },\n \"meta_attribution\": {\n \"utm_source\": \"<string>\",\n \"utm_medium\": \"<string>\",\n \"utm_campaign\": \"<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://crm-api.automatebusiness.com/api/v1/integrations-public/leads")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Corp Enterprise Deal\",\n \"email\": \"lead@acmecorp.com\",\n \"phone\": \"+15559876543\",\n \"pipeline_id\": \"pipe_default\",\n \"stage_name\": \"New Lead\",\n \"assigned_to\": \"user_sarah\",\n \"tags\": [\n \"enterprise\",\n \"inbound\"\n ],\n \"custom_fields\": {\n \"deal_value\": 50000\n },\n \"meta_attribution\": {\n \"utm_source\": \"<string>\",\n \"utm_medium\": \"<string>\",\n \"utm_campaign\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://crm-api.automatebusiness.com/api/v1/integrations-public/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["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Corp Enterprise Deal\",\n \"email\": \"lead@acmecorp.com\",\n \"phone\": \"+15559876543\",\n \"pipeline_id\": \"pipe_default\",\n \"stage_name\": \"New Lead\",\n \"assigned_to\": \"user_sarah\",\n \"tags\": [\n \"enterprise\",\n \"inbound\"\n ],\n \"custom_fields\": {\n \"deal_value\": 50000\n },\n \"meta_attribution\": {\n \"utm_source\": \"<string>\",\n \"utm_medium\": \"<string>\",\n \"utm_campaign\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "lead_890ef12a",
"name": "Acme Corp Enterprise Deal",
"email": "lead@acmecorp.com",
"phone": "+15559876543",
"pipeline_id": "pipe_default",
"stage_id": "stage_contacted",
"stage_name": "Contacted",
"assigned_to": "user_sarah",
"tags": [
"enterprise",
"q4-inbound"
],
"custom_fields": {
"deal_value": 50000,
"industry": "Technology"
},
"meta_attribution": {
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "fall_promo"
},
"created_at": "2026-10-26T09:30:00.000Z",
"updated_at": "2026-10-26T09:30:00.000Z"
},
"error": null
}{
"success": false,
"data": null,
"error": {
"message": "Validation failed",
"details": [
{
"message": "Required",
"field": "email",
"code": "invalid_type"
}
]
}
}{
"success": false,
"data": null,
"error": {
"message": "Invalid or missing API key."
}
}{
"success": false,
"data": null,
"error": {
"message": "Forbidden: insufficient permissions for this operation."
}
}{
"success": false,
"data": null,
"error": {
"message": "Conflict: resource with unique identifier already exists."
}
}