Skip to main content
PUT
Declares or replaces a lead source: a sheet, webhook or import source by name,

Authorizations

Authorization
string
header
required

An Erdo API key (erdo_api_...) or scoped token (erdo_token_...).

Body

application/json
account_id
string

written with or without "act_".

budget
LeadSourceBudget says which question on an ad platform's lead form asks the budget and what each · object

of its options means. A form asks the budget in its own words ("US$550K–1M"), and the canonical budget columns hold a range in minor units, so the meaning has to be declared: it is never read out of the option text. Each lead's chosen option is turned into the landing kit's budget keys (ds_storage.BudgetRangeKey and friends), and ingestion writes the canonical answer from those exactly as it does for a page (stampBudget). See docs/dataset-declarations.md.

connection_id
string

(integration id) for the provider; Pipedream connector account ids are refused.

create_only
boolean

import source with this name exists, so adding a source never replaces one. Refused for an ad platform declaration, which is keyed by its ad account.

dataset
string
dry_run
boolean

nothing. For a sheet it reads the tab; for a webhook it maps sample; for a LinkedIn declaration it proves the dataset, the connection's Lead Sync grant and every form's owner; for a Meta declaration it proves the dataset, the connection's leads_retrieval grant on the ad account, every form's Page and that each form's leads can be read.

enabled
boolean

Saving an existing sheet, webhook or import source without enabled keeps its current state, so rotating a paused webhook's secret leaves it paused.

forms
string[]

belong to account_id; a Meta Instant Form must be on a Page account_id promotes, and only leads from that account's ads are written.

if_updated_at
string

read. The save is refused (aborted) when the source was saved since, so two people editing one source cannot overwrite each other's change. Refused for an ad platform declaration.

mapping
LeadSourceMapping is a declared source's column mapping. · object
name
string

digits and hyphens, unique in the organization. Saving the same name again replaces that source.

provider
string

"meta_ads" (Meta Instant Forms), "google_sheets", "webhook" or "import".

rotate_secret
boolean

working at once. Refused for any other provider.

sample
sample is a webhook body to preview the mapping against. Refused for an · object | null

ad platform declaration, which reads its fields from the lead form.

sheet_url
string

(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.

Response

Success response

account_id
string

"act_" prefix). Only responses this account owns are ever written.

budget
LeadSourceBudget says which question on an ad platform's lead form asks the budget and what each · object

of its options means. A form asks the budget in its own words ("US$550K–1M"), and the canonical budget columns hold a range in minor units, so the meaning has to be declared: it is never read out of the option text. Each lead's chosen option is turned into the landing kit's budget keys (ds_storage.BudgetRangeKey and friends), and ingestion writes the canonical answer from those exactly as it does for a page (stampBudget). See docs/dataset-declarations.md.

connection_id
string

responses are read through.

created_at
string
dataset
string
enabled
boolean
forms
string[]
id
string
last_delivery_at
string

including one that matched an existing lead (RFC 3339).

last_error
string
last_run_at
string

empty when it never has.

mapping
LeadSourceMapping is a declared source's column mapping. · object
name
string

("brickell-meta-forms-spreadsheet"); empty for an ad platform declaration.

preview
LeadSourcePreview is a dry run's account of what a source would write. · object
provider
string

"google_sheets", "webhook" or "import".

read_via
string

sheet's open link. It stops working if link sharing is turned off.

sheet_url
string
synced_through
string

handled through (RFC 3339), or empty before the first complete sync.

updated_at
string

microsecond). For a sheet, webhook or import source, send it back as if_updated_at to save only an unchanged source. Saving a LinkedIn or Meta declaration refuses if_updated_at; deleting one still accepts it and deletes only an unchanged declaration.

webhook_secret
string

returned once, when the source is created or the secret rotated, and is never stored.

webhook_url
string