Create or Update a Lead

Updated
  • 5 minute(s) read
Prev Next
Post
/api/Lead/CreateOrUpdate
Security
HTTP
Type bearer

Enter the token obtained from the /token endpoint. Use the format: Bearer

Body parameters
object

Represents a lead

SendLeadEmail
boolean

Optional, Sends the lead email, default is true

AddToCampaigns
boolean

Optional, Add to MaidCentral campaigns, if enabled, default is true

TriggerWebhook
boolean

Optional, Triggers applied Keap, Zapier, if enabled, default is true

AllowDuplicates
boolean

Controls whether to create a new lead or link to an existing lead when matching contact information is found, Links to existing lead with matching contact info, default is false

LeadId
integer (int32)
FirstName
string Required
LastName
string Required
Email
string Required
Phone
string Required
PostalCode
string Required

Checks to see if the postal code is in the Home Zones

RedirectUrl
string

Optional, Custom url to be included in the response

Notes
string

Optional, To create a single note to be associated with the Lead

CustomerSourceId
integer (int32)

Optional, Valid options are supplied via /api/Lead/CustomerSources

LeadTagIds
Array of integer

Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 8

integer (int32)
utm_source
string
utm_medium
string
utm_campaign
string
utm_term
string
utm_content
string
object

Represents a lead

SendLeadEmail
boolean

Optional, Sends the lead email, default is true

AddToCampaigns
boolean

Optional, Add to MaidCentral campaigns, if enabled, default is true

TriggerWebhook
boolean

Optional, Triggers applied Keap, Zapier, if enabled, default is true

AllowDuplicates
boolean

Controls whether to create a new lead or link to an existing lead when matching contact information is found, Links to existing lead with matching contact info, default is false

LeadId
integer (int32)
FirstName
string Required
LastName
string Required
Email
string Required
Phone
string Required
PostalCode
string Required

Checks to see if the postal code is in the Home Zones

RedirectUrl
string

Optional, Custom url to be included in the response

Notes
string

Optional, To create a single note to be associated with the Lead

CustomerSourceId
integer (int32)

Optional, Valid options are supplied via /api/Lead/CustomerSources

LeadTagIds
Array of integer

Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 8

integer (int32)
utm_source
string
utm_medium
string
utm_campaign
string
utm_term
string
utm_content
string
object

Represents a lead

SendLeadEmail
boolean

Optional, Sends the lead email, default is true

AddToCampaigns
boolean

Optional, Add to MaidCentral campaigns, if enabled, default is true

TriggerWebhook
boolean

Optional, Triggers applied Keap, Zapier, if enabled, default is true

AllowDuplicates
boolean

Controls whether to create a new lead or link to an existing lead when matching contact information is found, Links to existing lead with matching contact info, default is false

LeadId
integer (int32)
FirstName
string Required
LastName
string Required
Email
string Required
Phone
string Required
PostalCode
string Required

Checks to see if the postal code is in the Home Zones

RedirectUrl
string

Optional, Custom url to be included in the response

Notes
string

Optional, To create a single note to be associated with the Lead

CustomerSourceId
integer (int32)

Optional, Valid options are supplied via /api/Lead/CustomerSources

LeadTagIds
Array of integer

Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 8

integer (int32)
utm_source
string
utm_medium
string
utm_campaign
string
utm_term
string
utm_content
string
object

Represents a lead

SendLeadEmail
boolean

Optional, Sends the lead email, default is true

AddToCampaigns
boolean

Optional, Add to MaidCentral campaigns, if enabled, default is true

TriggerWebhook
boolean

Optional, Triggers applied Keap, Zapier, if enabled, default is true

AllowDuplicates
boolean

Controls whether to create a new lead or link to an existing lead when matching contact information is found, Links to existing lead with matching contact info, default is false

LeadId
integer (int32)
FirstName
string Required
LastName
string Required
Email
string Required
Phone
string Required
PostalCode
string Required

Checks to see if the postal code is in the Home Zones

RedirectUrl
string

Optional, Custom url to be included in the response

Notes
string

Optional, To create a single note to be associated with the Lead

CustomerSourceId
integer (int32)

Optional, Valid options are supplied via /api/Lead/CustomerSources

LeadTagIds
Array of integer

Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 8

integer (int32)
utm_source
string
utm_medium
string
utm_campaign
string
utm_term
string
utm_content
string
object

Represents a lead

SendLeadEmail
boolean

Optional, Sends the lead email, default is true

AddToCampaigns
boolean

Optional, Add to MaidCentral campaigns, if enabled, default is true

TriggerWebhook
boolean

Optional, Triggers applied Keap, Zapier, if enabled, default is true

AllowDuplicates
boolean

Controls whether to create a new lead or link to an existing lead when matching contact information is found, Links to existing lead with matching contact info, default is false

LeadId
integer (int32)
FirstName
string Required
LastName
string Required
Email
string Required
Phone
string Required
PostalCode
string Required

Checks to see if the postal code is in the Home Zones

RedirectUrl
string

Optional, Custom url to be included in the response

Notes
string

Optional, To create a single note to be associated with the Lead

CustomerSourceId
integer (int32)

Optional, Valid options are supplied via /api/Lead/CustomerSources

LeadTagIds
Array of integer

Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 8

integer (int32)
utm_source
string
utm_medium
string
utm_campaign
string
utm_term
string
utm_content
string
object

Represents a lead

SendLeadEmail
boolean

Optional, Sends the lead email, default is true

AddToCampaigns
boolean

Optional, Add to MaidCentral campaigns, if enabled, default is true

TriggerWebhook
boolean

Optional, Triggers applied Keap, Zapier, if enabled, default is true

AllowDuplicates
boolean

Controls whether to create a new lead or link to an existing lead when matching contact information is found, Links to existing lead with matching contact info, default is false

LeadId
integer (int32)
FirstName
string Required
LastName
string Required
Email
string Required
Phone
string Required
PostalCode
string Required

Checks to see if the postal code is in the Home Zones

RedirectUrl
string

Optional, Custom url to be included in the response

Notes
string

Optional, To create a single note to be associated with the Lead

CustomerSourceId
integer (int32)

Optional, Valid options are supplied via /api/Lead/CustomerSources

LeadTagIds
Array of integer

Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 8

integer (int32)
utm_source
string
utm_medium
string
utm_campaign
string
utm_term
string
utm_content
string
Responses
200

Successful Response

Expand All
object
IsSuccess
boolean
Message
string
Result
object (CustomerQuoteDto)
LeadId
integer (int32)
CustomerInformationId
integer (int32)
HomeInformationId
integer (int32)
FirstName
string
LastName
string
Email
string
Phone
string
PostalCode
string
StatusId
integer (int32)
StatusName
string
BaseSiteUrl
string
MaidServiceQuoteUrl
string
ActivateUrl
string
CustomerSourceId
integer (int32)
CustomerSourceName
string
BillingTermsId
integer (int32)
BillingTermsName
string
ScopeGroupId
integer (int32)
ScopeGroupName
string
HomeAddress1
string
HomeAddress2
string
HomeCity
string
HomeRegion
string
HomePostalCode
string
BillingAddress1
string
BillingAddress2
string
BillingCity
string
BillingRegion
string
BillingPostalCode
string
InnerException
string
StatusCode
integer (int32)
Expand All
object
IsSuccess
boolean
Message
string
Result
object (CustomerQuoteDto)
LeadId
integer (int32)
CustomerInformationId
integer (int32)
HomeInformationId
integer (int32)
FirstName
string
LastName
string
Email
string
Phone
string
PostalCode
string
StatusId
integer (int32)
StatusName
string
BaseSiteUrl
string
MaidServiceQuoteUrl
string
ActivateUrl
string
CustomerSourceId
integer (int32)
CustomerSourceName
string
BillingTermsId
integer (int32)
BillingTermsName
string
ScopeGroupId
integer (int32)
ScopeGroupName
string
HomeAddress1
string
HomeAddress2
string
HomeCity
string
HomeRegion
string
HomePostalCode
string
BillingAddress1
string
BillingAddress2
string
BillingCity
string
BillingRegion
string
BillingPostalCode
string
InnerException
string
StatusCode
integer (int32)
Expand All
object
IsSuccess
boolean
Message
string
Result
object (CustomerQuoteDto)
LeadId
integer (int32)
CustomerInformationId
integer (int32)
HomeInformationId
integer (int32)
FirstName
string
LastName
string
Email
string
Phone
string
PostalCode
string
StatusId
integer (int32)
StatusName
string
BaseSiteUrl
string
MaidServiceQuoteUrl
string
ActivateUrl
string
CustomerSourceId
integer (int32)
CustomerSourceName
string
BillingTermsId
integer (int32)
BillingTermsName
string
ScopeGroupId
integer (int32)
ScopeGroupName
string
HomeAddress1
string
HomeAddress2
string
HomeCity
string
HomeRegion
string
HomePostalCode
string
BillingAddress1
string
BillingAddress2
string
BillingCity
string
BillingRegion
string
BillingPostalCode
string
InnerException
string
StatusCode
integer (int32)
Expand All
object
IsSuccess
boolean
Message
string
Result
object (CustomerQuoteDto)
LeadId
integer (int32)
CustomerInformationId
integer (int32)
HomeInformationId
integer (int32)
FirstName
string
LastName
string
Email
string
Phone
string
PostalCode
string
StatusId
integer (int32)
StatusName
string
BaseSiteUrl
string
MaidServiceQuoteUrl
string
ActivateUrl
string
CustomerSourceId
integer (int32)
CustomerSourceName
string
BillingTermsId
integer (int32)
BillingTermsName
string
ScopeGroupId
integer (int32)
ScopeGroupName
string
HomeAddress1
string
HomeAddress2
string
HomeCity
string
HomeRegion
string
HomePostalCode
string
BillingAddress1
string
BillingAddress2
string
BillingCity
string
BillingRegion
string
BillingPostalCode
string
InnerException
string
StatusCode
integer (int32)
Expand All
object
IsSuccess
boolean
Message
string
Result
object (CustomerQuoteDto)
LeadId
integer (int32)
CustomerInformationId
integer (int32)
HomeInformationId
integer (int32)
FirstName
string
LastName
string
Email
string
Phone
string
PostalCode
string
StatusId
integer (int32)
StatusName
string
BaseSiteUrl
string
MaidServiceQuoteUrl
string
ActivateUrl
string
CustomerSourceId
integer (int32)
CustomerSourceName
string
BillingTermsId
integer (int32)
BillingTermsName
string
ScopeGroupId
integer (int32)
ScopeGroupName
string
HomeAddress1
string
HomeAddress2
string
HomeCity
string
HomeRegion
string
HomePostalCode
string
BillingAddress1
string
BillingAddress2
string
BillingCity
string
BillingRegion
string
BillingPostalCode
string
InnerException
string
StatusCode
integer (int32)