Update Lead Business

patch

https://api.prahsys.com/merchant/n1/leads/businesses/{leadBusinessId}

Update a lead business by ID

Path Params

leadBusinessId

string

required

length ≥ 1

The lead business id

Body Params

name

string

length ≥ 1

Name of the business

accountType

string

enum

Account type of the business

locationAddress

object | null

Location address of the business. Pass null to remove.

headquartersAddress

object | null

Headquarters address of the business. Pass null to remove.

phoneNumber

string | null

Phone number of the business

string | null

Email of the business

website

string | null

Website of the business

linkedInUrl

string | null

LinkedIn URL of the business (e.g. linkedin.com/company/acme-corp). A bare slug is also accepted. Pass null to clear.

industry

string

length ≥ 1

Industry the business operates in

managementSoftware

string | null

Management software used

specialty

string | null

Primary specialty name. Ignored when specialties is provided.

specialties

array of objects

REPLACE all specialties for this lead. Pass [] to clear all. At most one item may have isPrimary true; if none are flagged, the first item is promoted to primary.

specialties

paymentProvider

string | null

Payment provider used

cbctScanner

string | null

CBCT scanner model. Pass null to clear.

scansPerWeek

integer | null

≥ 0

Approximate number of CBCT scans per week. Pass null to clear.

operatories

integer | null

≥ 0

Number of operatories (treatment rooms) in the practice. Pass null to clear.

officeHours

object | null

Practice office hours keyed by day of week (MON–SUN). Times are 24h HH:mm in practice-local time. Each day is either { closed: true } or { open, close } with open earlier than close. Partial weeks are allowed. REPLACE semantics: the submitted object replaces stored hours (not merged). Pass null to clear.

bestTimeToVisit

object | null

Preferred visit window: optional days[], startTime/endTime as 24h HH:mm, and an optional note (max 120). REPLACE semantics: the submitted object replaces the stored value (not merged). Pass null to clear.

leadChannel

string

enum

Acquisition channel for the lead

leadSource

string | null

^[a-z0-9-]+$

Source within the channel (lowercase-hyphenated)

leadCampaign

string | null

^[a-z0-9-]+$

Campaign identifier (lowercase-hyphenated)

leadMedium

string | null

^[a-z0-9-]+$

Marketing medium within the channel (lowercase-hyphenated, e.g. email, cpc)

leadContent

string | null

^[a-z0-9-]+$

Differentiates similar content/links within the same campaign (lowercase-hyphenated)

numberOfLocations

integer | null

Number of locations for this business

numberOfProviders

integer | null

Number of providers at this business

dsoSize

enum

DSO size category — only applicable for DSO Parent account type

The size category for a DSO Parent account. EMERGING (3-9 locations), MID_MARKET (10-75 locations), ELITE (76+ locations), MOBILE (mobile practice)

merchantId

string | null

Merchant ID if the lead has signed up

ownerUserIds

array of strings

User IDs to assign as owners (replaces all)

ownerUserIds

primaryOwnerUserId

string | null

User ID of the primary owner. Required when ownerUserIds has more than one entry; must be one of ownerUserIds. Pass null when 0–1 owners.

contactIds

array of strings

Contact IDs to link to this business (replaces all)

contactIds

leadEventId

string | null

ID of the lead event to enroll this business in. Pass null to un-enroll.

Responses

Language

Credentials

Bearer

API Key

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

401Unauthorized

404Not Found

500Internal Server Error