Overview
This API implements controls around the Lead Insert process to provide0030 more control over what can be uploaded.
- Lead Post API functions similarly to Lead Insert API, with the exception that the Non-Asset values are retrieved from the Lead Post Criteria configuration.
- Lead Post checks for the required fields, retrieves Non Asset options using the Criteria Key, constructs the complete set of parameters, then calls the Lead Insert API.
Contents
Read More:
Lead Post API
- Click the API menu.
- Click the Lead Post menu option.
The Lead Post page will open.
Required Parameters
(indicated in red)
- API Token
- Lead Criteria Key
- Lead Phone Number
Optional Parameters are also listed in the Arguments table below.
Arguments
| POST Field (case sensitive) | Type | Description | Required/Optional |
|---|---|---|---|
| auth_token | string | API authentication token | Required |
| criteria_key | string | The unique identifier for the criteria to be applied to the request | Required |
| phone_code | string | Lead`s phone code. Default is 1 | Optional |
| status | string | Lead`s status | Optional |
| created_by | lookup | Created By | Optional |
| Optional | |||
| last_modified_by | lookup | Last Modified By | Optional |
| owner_id | lookup | Lead Owner | Optional |
| first_name | text | First Name | Optional |
| last_name | text | Last Name | Optional |
| phone_number | phone | Primary Phone | Required |
| alt_phone_1 | phone | Cell Phone | Optional |
| alt_phone_2 | phone | Work Phone | Optional |
| address1 | text | Address 1 | Optional |
| address2 | text | Address 2 | Optional |
| city | text | City | Optional |
| state | select | State | Optional |
| province | text | Province | Optional |
| postal_code | text | Postal Code | Optional |
| country | select | Country | Optional |
| gender | select | Gender | Optional |
| date_of_birth | date | Date Of Birth | Optional |
| need_pet_insurance | checkbox | Training - Do you need Pet Insurance? | Optional |
| monthly_cost | text | Training - Monthly Cost | Optional |
| do_you_currently_have_insurance | checkbox | Training - Do you currently have insurance | Optional |
| ka_sge_2_select | select | Training - Insurance Provider | Optional |
| training_select_long | long_select | Training Select Long | Optional |
| indian_rupees | number | INR | Optional |
| ae_sge2_select | select | AE - SGE2 Select | Optional |
| ae_sge2_checkbox | checkbox | AE SGE 2 Checkbox | Optional |
| date_of_joining_the_policy | datetime | Date of joining | Optional |
| new_test_field | checkbox | Field | Optional |
| dons_test_phone_number | phone | Dons test phone number | Optional |
| ac___insurance_providers | select | AC SGE 2 Insurance Providers | Optional |
| ac_sge_2 | checkbox | AC SGE 2 - YAY or NAY? | Optional |
| avtestfield0304 | checkbox | AVTestField0304 | Optional |
| test0304 | checkbox | Test0304 | Optional |
| av_sge2_select | select | AV-SGE2-Select | Optional |
| av_sge2_checkbox | checkbox | AV-SGE2-Checkbox | Optional |
| indian_rupees1 | number | INR6 | Optional |
| estest | phone | ES Test | Optional |
| le3_sge2_select_es_313 | select | LE3 SGE2 Select ES 313 | Optional |
| le3_sge2_text_es_313 | text | LE3 SGE2 Text ES 313 | Optional |
| insurance__provider_le3_313_sg4_es | select | Insurance Provider LE3 313 SG4 ES | Optional |
| insurance_cost_le3_313_sg4_es | text | Insurance Cost LE3 313 SG4 ES | Optional |
| lg___sge_2_select | select | LG - SGE 2 Select | Optional |
| lg___sge_2_texrt | textarea_long | LG - SGE 2 Text | Optional |
| gujarat | state | GJ | Optional |
| rb_insurance_provider | select | RB Insurance Provider | Optional |
| rb_insurance_cost | text | RB Insurance Cost | Optional |
| ah_test_field | checkbox | AH Field | Optional |
| pbj | checkbox | Have you had the PB&J? | Optional |
| allans_insurance_provider | select | AH - SGE 2 Select | Optional |
| already_have_insurance | checkbox | AH SGE 2 Checkbox | Optional |
| ah_sge4_insurance_cost | text | AH SGE4 Insurance Cost | Optional |
| ah_sge4_insurance_provider | select | AH SGE4 Insurance Provider | Optional |
| npg___sge_2_select | select | NPG - PBJ | Optional |
| what_is_the_best_sandwich | text | NPG - SGE 2 Text | Optional |
| npg_sg_ex_4_ins_prov | select | NPGINSPROV | Optional |
| npg_sg_ex_4_ins_cost | text | NPGInsCost | Optional |
| rupees | number | Ind rup | Optional |
| username | textarea | username | Optional |
| pc_sge_2_select | select | ICICI Insurance Pvt Ltd. | Optional |
| pc_sge_checkbox | checkbox | PC Checkbox | Optional |
| pc_insurance_provider_name_field | text | PC Insurance Provider | Optional |
| pc_insurance_cost_field | integer | PC Insurance Cost | Optional |
| rm___sge_2_select | select | RM - SGE 2 Select | Optional |
| rm___sge_2_checkbox | checkbox | RM - SGE 2 Checkbox | Optional |
| rm_sge4_insurance_provider | text | RM SGE4 Insurance Provider | Optional |
| rm_sge4_insurance_cost | number | RM SGE4 Insurance Cost | Optional |
| rm_insurance_provider | select | RM Insurance Provider | Optional |
| rm_insurance_cost | text | RM Insurance Cost | Optional |
Output Parameters
Result
-
True
If the Lead meets the configuration requirements. -
False
Lead was not inserted.-
Reasons
- It was a duplicate and duplicates are not allowed,
- Minimum Age for a duplicate not reached.
-
Reasons
Result
-
-
Lead ID
Lead ID of the inserted record. -
Error
Includes description (e.g. a required field was not provided.)
-
Lead ID