API Reference

Update Lead Business

patch
https://api.prahsys.com/merchant/n1/leads/businesses/

Update a lead business by ID

Path Params
string
required
length ≥ 1

The lead business id

Body Params
string
length ≥ 1

Name of the business

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.

string | null

Phone number of the business

string | null

Email of the business

string | null

Website of the business

string
length ≥ 1

Industry the business operates in

string | null

Management software used

string | null

Specialty of the business within its industry

string | null

Payment provider used

string | null

CBCT scanner model. Pass null to clear.

integer | null
≥ 0

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

string
enum

Acquisition channel for the lead

string | null
^[a-z0-9-]+$

Source within the channel (lowercase-hyphenated)

string | null
^[a-z0-9-]+$

Campaign identifier (lowercase-hyphenated)

integer | null

Number of locations for this business

integer | null

Number of providers at this business

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)

string | null

Merchant ID if the lead has signed up

ownerUserIds
array of strings

User IDs to assign as owners (replaces all)

ownerUserIds
contactIds
array of strings

Contact IDs to link to this business (replaces all)

contactIds
string | null

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

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
API Key
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?