Skip to main content
PUT
Update a business lead intake source

Path Parameters

id
string
required

The ID of the source to update.

Body

The updated source data.

Request schema for the Leadping API lead source request, including the fields clients can send.

name
string
required

The display name for the entity.

Maximum string length: 255
description
string | null

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

enabled
boolean

Indicates whether this lead source request is active and available in the Leadping API.

apiKey
string | null

Source API key used to authenticate inbound lead delivery to Leadping.

regenerateApiKey
boolean

Indicates whether Leadping should issue a new API key for this source.

costPerLead
string<double> | null

Configured cost charged when this source creates a billable lead.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
allowedStates
string[]

State or region allowlist used to accept leads from this source.

allowedProducts
string[]

Product allowlist used to accept or route leads from this source.

requiresTrustedForm
boolean

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

defaultTagIds
string[]

Tag IDs automatically assigned to leads created by this source.

defaultTagNames
string[]

Tag names automatically assigned to leads created by this source.

id
string | null

The unique identifier for the entity, when updating an existing entity.

Response

Source was successfully updated.

Response schema for the Leadping API lead source response returned to authenticated clients.

description
string | null

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

enabled
boolean

Indicates whether this lead source response is active and available in the Leadping API.

apiKey
string | null

Source API key used to authenticate inbound lead delivery to Leadping. Unlike a business API key, this value remains available to authorized source users.

apiKeyPreview
string | null

Masked preview of the source API key for compact display.

firstLeadReceivedAt
string<date-time> | null

UTC timestamp when this source first delivered a lead to Leadping.

lastLeadReceivedAt
string<date-time> | null

UTC timestamp when this source most recently delivered a lead to Leadping.

user
object | null

User summary connected to this lead source response.

createdByUser
object | null

User summary for the person who created this lead source response.

modifiedByUser
object | null

User summary for the person who last modified this lead source response.

business
object | null

Business summary connected to this lead source response.

costPerLead
string<double> | null

Configured cost charged when this source creates a billable lead.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
allowedStates
string[]

State or region allowlist used to accept leads from this source.

allowedProducts
string[]

Product allowlist used to accept or route leads from this source.

requiresTrustedForm
boolean

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

complianceApproved
boolean

Indicates whether the business or sender passed compliance review.

defaultTagIds
string[]

Tag IDs automatically assigned to leads created by this source.

defaultTags
object[]

Default tag summaries automatically applied to leads from this source.

name
string

The display name for the entity.

id
string

The unique identifier for the entity.

createdAt
string<date-time>

The date and time when the entity was created.

modifiedAt
string<date-time> | null

The date and time when the entity was last modified, if applicable.