POST
/
leads
/
create

Authorizations

x-api-key
string
headerrequired

Body

application/json
firstName
string
required

The first name of the lead.

lastName
string
required

The last name of the lead.

phone
string
required

The phone number must begin with an area code (+) and can contain digits, spaces, parentheses, and hyphens (e.g. +1 (555) 555-5555)

customerProfile
string
required

The name of the customer profile to which this lead should belong to.

additionalInfo
object

An optional key-value object containing additional information to store with the lead.

Response

200 - application/json
message
string

Returns "Lead created successfully." if the lead was created successfully.

id
string

The ID of the lead that was created.

IntroductionGet lead