Declares a lead source: where leads Erdo did not capture itself come from,
curl --request PUT \
--url https://api.erdo.ai/v1/provider-lead-sources \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "<string>",
"connection_id": "<string>",
"create_only": true,
"dataset": "<string>",
"dry_run": true,
"enabled": true,
"forms": [
"<string>"
],
"if_updated_at": "<string>",
"mapping": {
"columns": {},
"consent": {
"method": "<string>",
"text": "<string>"
},
"default_country": "<string>",
"format": "<string>",
"ignore": [
"<string>"
],
"keep_other_fields": true,
"lead_source": "<string>",
"row_id": [
"<string>"
],
"submitted_at": "<string>",
"values": {},
"what_people_did": "<string>"
},
"name": "<string>",
"provider": "<string>",
"rotate_secret": true,
"sample": {},
"sheet_url": "<string>",
"suggest_columns": [
{
"description": "<string>",
"name": "<string>"
}
]
}
'import requests
url = "https://api.erdo.ai/v1/provider-lead-sources"
payload = {
"account_id": "<string>",
"connection_id": "<string>",
"create_only": True,
"dataset": "<string>",
"dry_run": True,
"enabled": True,
"forms": ["<string>"],
"if_updated_at": "<string>",
"mapping": {
"columns": {},
"consent": {
"method": "<string>",
"text": "<string>"
},
"default_country": "<string>",
"format": "<string>",
"ignore": ["<string>"],
"keep_other_fields": True,
"lead_source": "<string>",
"row_id": ["<string>"],
"submitted_at": "<string>",
"values": {},
"what_people_did": "<string>"
},
"name": "<string>",
"provider": "<string>",
"rotate_secret": True,
"sample": {},
"sheet_url": "<string>",
"suggest_columns": [
{
"description": "<string>",
"name": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
account_id: '<string>',
connection_id: '<string>',
create_only: true,
dataset: '<string>',
dry_run: true,
enabled: true,
forms: ['<string>'],
if_updated_at: '<string>',
mapping: {
columns: {},
consent: {method: '<string>', text: '<string>'},
default_country: '<string>',
format: '<string>',
ignore: ['<string>'],
keep_other_fields: true,
lead_source: '<string>',
row_id: ['<string>'],
submitted_at: '<string>',
values: {},
what_people_did: '<string>'
},
name: '<string>',
provider: '<string>',
rotate_secret: true,
sample: {},
sheet_url: '<string>',
suggest_columns: [{description: '<string>', name: '<string>'}]
})
};
fetch('https://api.erdo.ai/v1/provider-lead-sources', 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.erdo.ai/v1/provider-lead-sources",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'account_id' => '<string>',
'connection_id' => '<string>',
'create_only' => true,
'dataset' => '<string>',
'dry_run' => true,
'enabled' => true,
'forms' => [
'<string>'
],
'if_updated_at' => '<string>',
'mapping' => [
'columns' => [
],
'consent' => [
'method' => '<string>',
'text' => '<string>'
],
'default_country' => '<string>',
'format' => '<string>',
'ignore' => [
'<string>'
],
'keep_other_fields' => true,
'lead_source' => '<string>',
'row_id' => [
'<string>'
],
'submitted_at' => '<string>',
'values' => [
],
'what_people_did' => '<string>'
],
'name' => '<string>',
'provider' => '<string>',
'rotate_secret' => true,
'sample' => [
],
'sheet_url' => '<string>',
'suggest_columns' => [
[
'description' => '<string>',
'name' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.erdo.ai/v1/provider-lead-sources"
payload := strings.NewReader("{\n \"account_id\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"create_only\": true,\n \"dataset\": \"<string>\",\n \"dry_run\": true,\n \"enabled\": true,\n \"forms\": [\n \"<string>\"\n ],\n \"if_updated_at\": \"<string>\",\n \"mapping\": {\n \"columns\": {},\n \"consent\": {\n \"method\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"default_country\": \"<string>\",\n \"format\": \"<string>\",\n \"ignore\": [\n \"<string>\"\n ],\n \"keep_other_fields\": true,\n \"lead_source\": \"<string>\",\n \"row_id\": [\n \"<string>\"\n ],\n \"submitted_at\": \"<string>\",\n \"values\": {},\n \"what_people_did\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"provider\": \"<string>\",\n \"rotate_secret\": true,\n \"sample\": {},\n \"sheet_url\": \"<string>\",\n \"suggest_columns\": [\n {\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://api.erdo.ai/v1/provider-lead-sources")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"create_only\": true,\n \"dataset\": \"<string>\",\n \"dry_run\": true,\n \"enabled\": true,\n \"forms\": [\n \"<string>\"\n ],\n \"if_updated_at\": \"<string>\",\n \"mapping\": {\n \"columns\": {},\n \"consent\": {\n \"method\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"default_country\": \"<string>\",\n \"format\": \"<string>\",\n \"ignore\": [\n \"<string>\"\n ],\n \"keep_other_fields\": true,\n \"lead_source\": \"<string>\",\n \"row_id\": [\n \"<string>\"\n ],\n \"submitted_at\": \"<string>\",\n \"values\": {},\n \"what_people_did\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"provider\": \"<string>\",\n \"rotate_secret\": true,\n \"sample\": {},\n \"sheet_url\": \"<string>\",\n \"suggest_columns\": [\n {\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.erdo.ai/v1/provider-lead-sources")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_id\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"create_only\": true,\n \"dataset\": \"<string>\",\n \"dry_run\": true,\n \"enabled\": true,\n \"forms\": [\n \"<string>\"\n ],\n \"if_updated_at\": \"<string>\",\n \"mapping\": {\n \"columns\": {},\n \"consent\": {\n \"method\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"default_country\": \"<string>\",\n \"format\": \"<string>\",\n \"ignore\": [\n \"<string>\"\n ],\n \"keep_other_fields\": true,\n \"lead_source\": \"<string>\",\n \"row_id\": [\n \"<string>\"\n ],\n \"submitted_at\": \"<string>\",\n \"values\": {},\n \"what_people_did\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"provider\": \"<string>\",\n \"rotate_secret\": true,\n \"sample\": {},\n \"sheet_url\": \"<string>\",\n \"suggest_columns\": [\n {\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"account_id": "<string>",
"connection_id": "<string>",
"created_at": "<string>",
"dataset": "<string>",
"enabled": true,
"forms": [
"<string>"
],
"id": "<string>",
"last_delivery_at": "<string>",
"last_error": "<string>",
"last_run_at": "<string>",
"mapping": {
"columns": {},
"consent": {
"method": "<string>",
"text": "<string>"
},
"default_country": "<string>",
"format": "<string>",
"ignore": [
"<string>"
],
"keep_other_fields": true,
"lead_source": "<string>",
"row_id": [
"<string>"
],
"submitted_at": "<string>",
"values": {},
"what_people_did": "<string>"
},
"name": "<string>",
"preview": {
"already_written": 123,
"existing_columns": [
"<string>"
],
"format_columns": {},
"header": [
"<string>"
],
"history": 123,
"missing_fields": [
"<string>"
],
"new": 123,
"not_read": [
"<string>"
],
"read_columns": {},
"rows": 123,
"sample": [
{}
],
"skipped": {},
"suggested_columns": {},
"suggested_values": {},
"test": 123
},
"provider": "<string>",
"read_via": "<string>",
"sheet_url": "<string>",
"synced_through": "<string>",
"updated_at": "<string>",
"webhook_secret": "<string>",
"webhook_url": "<string>"
}{
"code": "not_found",
"details": {},
"message": "<string>"
}API Reference
Declares a lead source: where leads Erdo did not capture itself come from,
and which lead dataset they are written into, each exactly once.
- provider “linkedin_ads”: an ad account’s LinkedIn Lead Gen Form responses, read every fifteen minutes. Every form must belong to the account.
- provider “google_sheets”: a sheet tab open to anyone with the link (sheet_url), read every five minutes. Rows submitted before the source was declared are written as history; later rows as new leads.
- provider “webhook”: a tool posts each lead to webhook_url with the X-Erdo-Lead-Source-Secret header. The secret is returned once.
- provider “import”: files sent to POST /v1/provider-lead-sources/import.
Sheet, webhook and import sources are named and carry a column mapping (mapping.lead_source, format, row_id, submitted_at, columns); only mapped fields are read. dry_run previews what a source would write without saving. History is written with the lead’s own arrival and is never alerted on, billed or followed up until somebody starts it. The dataset must have lead identity turned on. Saving replaces the declaration with the same name (or provider and account).
REST only, with no MCP tool, like scheduled actions: connecting an ad account’s leads to a dataset is a commitment about whose prospects land where, made by somebody who holds the connection, not a step an agent takes mid-task.
PUT
/
v1
/
provider-lead-sources
Declares a lead source: where leads Erdo did not capture itself come from,
curl --request PUT \
--url https://api.erdo.ai/v1/provider-lead-sources \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "<string>",
"connection_id": "<string>",
"create_only": true,
"dataset": "<string>",
"dry_run": true,
"enabled": true,
"forms": [
"<string>"
],
"if_updated_at": "<string>",
"mapping": {
"columns": {},
"consent": {
"method": "<string>",
"text": "<string>"
},
"default_country": "<string>",
"format": "<string>",
"ignore": [
"<string>"
],
"keep_other_fields": true,
"lead_source": "<string>",
"row_id": [
"<string>"
],
"submitted_at": "<string>",
"values": {},
"what_people_did": "<string>"
},
"name": "<string>",
"provider": "<string>",
"rotate_secret": true,
"sample": {},
"sheet_url": "<string>",
"suggest_columns": [
{
"description": "<string>",
"name": "<string>"
}
]
}
'import requests
url = "https://api.erdo.ai/v1/provider-lead-sources"
payload = {
"account_id": "<string>",
"connection_id": "<string>",
"create_only": True,
"dataset": "<string>",
"dry_run": True,
"enabled": True,
"forms": ["<string>"],
"if_updated_at": "<string>",
"mapping": {
"columns": {},
"consent": {
"method": "<string>",
"text": "<string>"
},
"default_country": "<string>",
"format": "<string>",
"ignore": ["<string>"],
"keep_other_fields": True,
"lead_source": "<string>",
"row_id": ["<string>"],
"submitted_at": "<string>",
"values": {},
"what_people_did": "<string>"
},
"name": "<string>",
"provider": "<string>",
"rotate_secret": True,
"sample": {},
"sheet_url": "<string>",
"suggest_columns": [
{
"description": "<string>",
"name": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
account_id: '<string>',
connection_id: '<string>',
create_only: true,
dataset: '<string>',
dry_run: true,
enabled: true,
forms: ['<string>'],
if_updated_at: '<string>',
mapping: {
columns: {},
consent: {method: '<string>', text: '<string>'},
default_country: '<string>',
format: '<string>',
ignore: ['<string>'],
keep_other_fields: true,
lead_source: '<string>',
row_id: ['<string>'],
submitted_at: '<string>',
values: {},
what_people_did: '<string>'
},
name: '<string>',
provider: '<string>',
rotate_secret: true,
sample: {},
sheet_url: '<string>',
suggest_columns: [{description: '<string>', name: '<string>'}]
})
};
fetch('https://api.erdo.ai/v1/provider-lead-sources', 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.erdo.ai/v1/provider-lead-sources",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'account_id' => '<string>',
'connection_id' => '<string>',
'create_only' => true,
'dataset' => '<string>',
'dry_run' => true,
'enabled' => true,
'forms' => [
'<string>'
],
'if_updated_at' => '<string>',
'mapping' => [
'columns' => [
],
'consent' => [
'method' => '<string>',
'text' => '<string>'
],
'default_country' => '<string>',
'format' => '<string>',
'ignore' => [
'<string>'
],
'keep_other_fields' => true,
'lead_source' => '<string>',
'row_id' => [
'<string>'
],
'submitted_at' => '<string>',
'values' => [
],
'what_people_did' => '<string>'
],
'name' => '<string>',
'provider' => '<string>',
'rotate_secret' => true,
'sample' => [
],
'sheet_url' => '<string>',
'suggest_columns' => [
[
'description' => '<string>',
'name' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.erdo.ai/v1/provider-lead-sources"
payload := strings.NewReader("{\n \"account_id\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"create_only\": true,\n \"dataset\": \"<string>\",\n \"dry_run\": true,\n \"enabled\": true,\n \"forms\": [\n \"<string>\"\n ],\n \"if_updated_at\": \"<string>\",\n \"mapping\": {\n \"columns\": {},\n \"consent\": {\n \"method\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"default_country\": \"<string>\",\n \"format\": \"<string>\",\n \"ignore\": [\n \"<string>\"\n ],\n \"keep_other_fields\": true,\n \"lead_source\": \"<string>\",\n \"row_id\": [\n \"<string>\"\n ],\n \"submitted_at\": \"<string>\",\n \"values\": {},\n \"what_people_did\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"provider\": \"<string>\",\n \"rotate_secret\": true,\n \"sample\": {},\n \"sheet_url\": \"<string>\",\n \"suggest_columns\": [\n {\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://api.erdo.ai/v1/provider-lead-sources")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"create_only\": true,\n \"dataset\": \"<string>\",\n \"dry_run\": true,\n \"enabled\": true,\n \"forms\": [\n \"<string>\"\n ],\n \"if_updated_at\": \"<string>\",\n \"mapping\": {\n \"columns\": {},\n \"consent\": {\n \"method\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"default_country\": \"<string>\",\n \"format\": \"<string>\",\n \"ignore\": [\n \"<string>\"\n ],\n \"keep_other_fields\": true,\n \"lead_source\": \"<string>\",\n \"row_id\": [\n \"<string>\"\n ],\n \"submitted_at\": \"<string>\",\n \"values\": {},\n \"what_people_did\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"provider\": \"<string>\",\n \"rotate_secret\": true,\n \"sample\": {},\n \"sheet_url\": \"<string>\",\n \"suggest_columns\": [\n {\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.erdo.ai/v1/provider-lead-sources")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_id\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"create_only\": true,\n \"dataset\": \"<string>\",\n \"dry_run\": true,\n \"enabled\": true,\n \"forms\": [\n \"<string>\"\n ],\n \"if_updated_at\": \"<string>\",\n \"mapping\": {\n \"columns\": {},\n \"consent\": {\n \"method\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"default_country\": \"<string>\",\n \"format\": \"<string>\",\n \"ignore\": [\n \"<string>\"\n ],\n \"keep_other_fields\": true,\n \"lead_source\": \"<string>\",\n \"row_id\": [\n \"<string>\"\n ],\n \"submitted_at\": \"<string>\",\n \"values\": {},\n \"what_people_did\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"provider\": \"<string>\",\n \"rotate_secret\": true,\n \"sample\": {},\n \"sheet_url\": \"<string>\",\n \"suggest_columns\": [\n {\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"account_id": "<string>",
"connection_id": "<string>",
"created_at": "<string>",
"dataset": "<string>",
"enabled": true,
"forms": [
"<string>"
],
"id": "<string>",
"last_delivery_at": "<string>",
"last_error": "<string>",
"last_run_at": "<string>",
"mapping": {
"columns": {},
"consent": {
"method": "<string>",
"text": "<string>"
},
"default_country": "<string>",
"format": "<string>",
"ignore": [
"<string>"
],
"keep_other_fields": true,
"lead_source": "<string>",
"row_id": [
"<string>"
],
"submitted_at": "<string>",
"values": {},
"what_people_did": "<string>"
},
"name": "<string>",
"preview": {
"already_written": 123,
"existing_columns": [
"<string>"
],
"format_columns": {},
"header": [
"<string>"
],
"history": 123,
"missing_fields": [
"<string>"
],
"new": 123,
"not_read": [
"<string>"
],
"read_columns": {},
"rows": 123,
"sample": [
{}
],
"skipped": {},
"suggested_columns": {},
"suggested_values": {},
"test": 123
},
"provider": "<string>",
"read_via": "<string>",
"sheet_url": "<string>",
"synced_through": "<string>",
"updated_at": "<string>",
"webhook_secret": "<string>",
"webhook_url": "<string>"
}{
"code": "not_found",
"details": {},
"message": "<string>"
}Authorizations
An Erdo API key (erdo_api_...) or scoped token (erdo_token_...).
Body
application/json
(integration id) for the provider; Pipedream connector account ids are refused.
import source with this name exists, so adding a source never replaces one.
write, saving nothing. For a sheet it reads the tab; for a webhook it maps sample.
Saving an existing sheet, webhook or import source without enabled keeps its current state, so rotating a paused webhook's secret leaves it paused.
account_id.
read. The save is refused (aborted) when the source was saved since, so two people editing one source cannot overwrite each other's change.
Show child attributes
Show child attributes
digits and hyphens, unique in the organization. Saving the same name again replaces that source.
working at once.
(including #gid=). The tab must be open to anyone with the link.
suggest_columns
LeadSourceSuggestColumn is a lead column a sheet's fields may be matched to.
· object[]
wants the sheet's fields matched to (is_broker, budget, timeline, phone, name), each with what it records. The preview suggests a field only for one of these, and leaves every other field without a suggestion. Without it the lead dataset's own columns are used.
Show child attributes
Show child attributes
Response
Success response
owns are ever written.
responses are read through.
including one that matched an existing lead (RFC 3339).
empty when it never has.
Show child attributes
Show child attributes
("brickell-meta-forms-spreadsheet"); empty for a LinkedIn declaration.
Show child attributes
Show child attributes
"webhook" or "import".
sheet's open link. It stops working if link sharing is turned off.
handled through (RFC 3339), or empty before the first complete sync.
microsecond). Send it back as if_updated_at to save only an unchanged source.
returned once, when the source is created or the secret rotated, and is never stored.