API Reference

Create Lead Business

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

Create a new lead business

Body Params
string
required
length ≥ 1

Name of the business

string
enum
required

Account type of the business

locationAddress
object

Location address of the business

headquartersAddress
object

Headquarters address of the business

string

Phone number of the business

string

Email of the business

string

Website of the business

string

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

string
required
length ≥ 1

Industry the business operates in

string

Management software used

string

Primary specialty name. Ignored when specialties is provided.

specialties
array of objects

All specialties for this lead. At most one item may have isPrimary true; if none are flagged, the first item is promoted to primary.

specialties
string

Payment provider used

string

CBCT scanner model used by the practice

integer
≥ 0

Approximate number of CBCT scans performed per week

integer
≥ 0

Number of operatories (treatment rooms) in the practice

additional
object

Free-form key/value CRM enrichment shown on the lead (e.g. role, scansPerMonth).

string
enum
required

Acquisition channel for the lead

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

Source within the channel (lowercase-hyphenated)

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

Campaign identifier (lowercase-hyphenated)

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

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

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

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

integer

Number of locations for this business

integer

Number of providers at this business

string
enum

DSO size category — only applicable for DSO Parent account type

Allowed:
ownerUserIds
array of strings

User IDs to assign as owners

ownerUserIds
string | null

User ID of the primary owner. Required when ownerUserIds has more than one entry; must be one of ownerUserIds.

contactIds
array of strings

Contact IDs to link to this business

contactIds
string

DSO Connect entity id (parent_dso_id, subsidiary_id, or practice_location_id) — must be unique per lead.

string

ID of the lead event to enroll this business in at creation time.

number

Initial monthly processing amount for the deal.

string

Explanatory note for the deal (e.g. how the amount was calculated).

string
enum

Initial lead status. Defaults to NEW if not provided. Pass PROSPECT to create a pre-pipeline lead.

Allowed:
string
enum

Initial deal status. Defaults to NEW if not provided (e.g. DISCOVERY for a self-onboarded merchant).

string

DB id of an existing merchant to link this lead to (LeadBusinesses.merchant_id). Must be unique per merchant.

Responses

Updated 5 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 5 months ago

Did this page help you?