Creates a lead

post

https://api.vcita.biz/platform/v1/leadgen

Overview

Creates a lead Available for Staff, App, and Directory tokens.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

address

string

Lead's address

business_id

string

A unique identifier of the business. Can be the Business UID or nickname\external ID.

string

Lead email address. Unique per business.

first_name

string

required

Lead first name. Mandatory for a new lead.

identifier_type

string

required

Defines which unique identifier will be used to search for an existing lead or create a new one. Possible values: "email" or "unique_id"

last_name

string

Lead last name.

message_data

object

Key and value that will appear in message

notifications

string

A list of notifications to send after processing of the lead. Possible values: "auto-reply" (thank you email to the end user), "email" (notify the business owner) or "sms" (text notification to the business owner). None if empty.

opt_in

string

Send "true" if lead opted in for promotions. Make sure the "opt-in" client card field is added to the client card under Settings>Client card.

opt_in_transactional_sms

boolean

Whether the client opts in to receive transactional SMS messages.

phone

string

Lead phone number.

request_data

object

Key and value properties that will update new lead and appear in message

request_title

string

required

Request title. Will also be the created conversation title.

source

string

Will be displayed to the business owner as the lead source

source_url

string

The URL of the page where the lead was created.

status

string

Use a client status to categorize clients according to their relationship with your business, default is Lead.

system_message

string

A message displayed to the business owner to introduce the lead. May contain links.

201Success