| lead | {
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have ht following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}- id: A unique numeric identifier for the lead.
- first_name: The lead's first name.
- middle_name: The lead's middle name.
- last_name: The lead's last name.
- last_name2: The lead's second last name.
- email: The lead's email address.
- phone_country_code: The lead's phone country code.
- phone: The lead's phone.
- company: The lead's company.
- address: The lead's address.
- city: The lead's city.
- zip: The lead's zip.
- state: The lead's state.
- country: The lead's country.
- date_joined: The date when the lead joined kartra.
- website: The lead's website.
- ip: The lead's IP.
- ip_country: The lead's IP country.
- facebook: The lead's facebook URL.
- twitter: The lead's twitter URL.
- linkedin: The lead's linkedin URL.
- sales_tax_id: The lead's sales tax id.
- lead_picture: The lead's picture URL.
- source: The lead's creation source ('single-optin','double-optin','helpdesk','affiliate-signup','checkout','import','api','manual','checkout-first').
- score: The lead's score.
- referring_id: The lead's referring affiliate id.
- blacklisted: If the lead is blacklisted or not (0/1).
- source_id: The lead's source assed id.
- gdpr_lead_status: The lead's GDPR status, possible values: 0 - For GDPR status off - Your account has GDPR deactivated 1 - For GDPR status not subject - The lead's IP is from a country not subject to GDPR 2 - For GDPR status accepted - The lead has accepted the GDPR terms 3 - For GDPR status not accepted - The lead hasn't accepted the GDPR terms 4 - For GDPR status unknown - The lead's location could not be determined 5 - For GDPR status pending
- gdpr_lead_status_date: The date of the last GDPR status change
- gdpr_lead_status_ip: The IP of the last GDPR status change
- gdpr_lead_communications: 0 - if the user has agreed to be contacted, 1 - if not
- lead_preferred_time_zone: The lead's preferred time zone.
- custom fields:
- field_id - the unique id reference (integer)
- field_identifier - the unique identifier chosen when it was created (string)
- field_type - the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
- field_value - the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
|
|
| action_details | "calendar":{
"calendar_id":integer,
"calendar_name":string,
"class_id":integer,
"class_name":string,
"hosts":[
{
"host_first_name":"host",
"host_last_name":"host",
"host_email_address":"hostemail@gmail.com"
},
{
"host_first_name":"co-host",
"host_last_name":"co-host",
"host_email_address":"cohostemail@gmail.com"
}
],
"vendor_timezone":"America/Detroit",
"calendar_subscription_id":123,
"events":[
{
"event_date":"2020-12-11 09:00",
"event_duration":60
},
{
"event_date":"2020-12-14 09:00",
"event_duration":120
}
],
"calendar_subscription_status":"Completed"
}
- calendar_id: A unique numeric identifier for the kartra calendar.
- calendar_name: The kartra calendar name.
- class_id: A unique numeric identifier for the kartra calendar class.
- class_name: The kartra calendar class name.
- hosts: The host and co-hosts of the class.
- vendor_timezone: The vendor account timezone.
- calendar_subscription_id: The id of the lead calendar subscription.
- events: An array with the events date and duration.
- calendar_subscription_status: The status of the lead calendar subscription.
|
