Skip to main content
POST
Create an organization lead intake source

Authorizations

Authorization
string
header
required

Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.

Body

The source data to create.

Defines the fields clients can send when working with lead source.

defaultTagIds
string[]
required

Tag IDs automatically assigned to leads created by this source.

defaultTagNames
string[]
required

Tag names automatically assigned to leads created by this source.

name
null | string

Human-readable source name.

dailyLeadLimit
null | integer<int32>

Maximum new leads accepted per UTC day. Null means unlimited; zero pauses intake.

description
null | string

Human-readable description that explains this lead source request to API users.

automaticPhoneLookup
boolean

Whether to look up lead phone numbers during intake. When disabled, lookup is required before calling or texting.

Whether to validate consent certificates during intake. Skipped validation leaves consent unverified.

requiresTrustedForm
boolean

Indicates whether leads from this source must include a TrustedForm or Leadping Consent certificate for consent proof.

Response

Source was successfully created.

Returns a newly issued source credential exactly once.

source
object

Describes lead source data returned by Leadping.

secret
string

Newly issued source credential. Leadping does not retain this plaintext value.