Lead: Searching, Creating, Editing

'lead' => [
    'email' => '[email protected]',
    'first_name' => 'John',
    'last_name' => 'Smith',
    'custom_fields' => [
        '0' => [
            'field_identifier' => 'text1',
            'field_value' => 'text message'
        ],
        '1' => [
            'field_identifier' => 'dropdown1',
            'field_value' => '612'
        ],
        '2' => [
            'field_identifier' => 'checkbox1',
            'field_value' => [620]
        ],
    ],
], 
'actions' => [ 
    '0' => [ 
        'cmd' => 'create_lead' 
    ] 
]

{
  "status": "Success",
  "actions": [
    {
      "create_lead": {
        "status": "Success",
        "lead_details": {
          "id": "1234"
        }
      }
    }
  ]
}

{
  "status": "Error",
  "message": "Lead already exists",
  "type": "244"
}

'actions' => array(
'0' => array( 'cmd' => 'create_lead', ),
'1' => array( 'cmd' => 'assign_tag', ),
'2' => array( 'cmd' => 'subscribe_lead_to_list', )
)

** Either the ID or the EMAIL are required in order for a lead to be correctly identified and updated.

*** The custom field identifier must have previously been created in your Kartra account. Otherwise, if the API call doesn't find the corresponding custom field name, the instruction will be ignored.

The array will consist of arrays with two parameters:

• field_identifier (string) - the unique identifier chosen when it was created
• field_value (array/string/integer) - the values will be strings for input_field and text_area, integers with the option id for drop_down and radio_button, array containing the option ids for checkboxes. To clear the values, you need to send an empty string.

The system will firstly conduct a search for an existing lead with the provided ID or EMAIL. If the lead is found, it will be updated according to the data being passed in the API call. Conversely, if no lead is found, the system will throw an error (see below).

If the call contains the parameter new_email, this will be validated against your current database to make sure no other existing lead is already registered under that email address. If a lead is found an error message will be thrown.

Here is an example of sending parameters:

'lead' => [
    'email' => '[email protected]',
    'first_name' => 'John',
    'last_name' => 'Smith',
    'new_email' => '[email protected]',
    'custom_fields' => [
        '0' => [
            'field_identifier' => 'text1',
            'field_value' => 'text message'
        ],
        '1' => [
            'field_identifier' => 'dropdown1',
            'field_value' => '612'
        ],
        '2' => [
            'field_identifier' => 'checkbox1',
            'field_value' => [620]
        ],
    ],
],
'actions' => [
    '0' => [
        'cmd' => 'edit_lead'
    ]
]

Success message:

{
  "status": "Success",
  "actions": [
    {
      "edit_lead": {
        "status": "Success",
        "lead_details": {
          "id": "1234"
        }
      }
    }
  ]
}

Error Cases:

An example of an error message:

{
  "status": "Error",
  "message": "Lead already exists",
  "type": "244"
}

***** Timezone options:

1. America/Los_Angeles
2. America/Boise
3. America/Chicago
4. America/New_York
5. Europe/London
6. Europe/Brussels
7. Etc/GMT+12
8. Pacific/Midway
9. Pacific/Honolulu
10. America/Juneau
11. America/Chihuahua
12. America/Phoenix
13. America/Regina
14. America/Mexico_City
15. America/Belize
16. America/Indiana/Indianapolis
17. America/Bogota
18. America/Glace_Bay
19. America/Caracas
20. America/Santiago
21. America/St_Johns
22. America/Sao_Paulo
23. America/Argentina/Buenos_Aires
24. America/Nuuk
25. Etc/GMT+2
26. Atlantic/Azores
27. Atlantic/Cape_Verde
28. Africa/Casablanca
29. Atlantic/Canary
30. Europe/Belgrade
31. Europe/Sarajevo
32. Europe/Amsterdam
33. Africa/Algiers
34. Europe/Bucharest
35. Africa/Cairo
36. Europe/Helsinki
37. Europe/Athens
38. Asia/Jerusalem
39. Africa/Harare
40. Europe/Moscow
41. Asia/Kuwait
42. Africa/Nairobi
43. Asia/Baghdad
44. Asia/Tehran
45. Asia/Dubai
46. Asia/Baku
47. Asia/Kabul
48. Asia/Yekaterinburg
49. Asia/Karachi
50. Asia/Kolkata
51. Asia/Kathmandu
52. Asia/Dhaka
53. Asia/Colombo
54. Asia/Almaty
55. Asia/Rangoon
56. Asia/Bangkok
57. Asia/Krasnoyarsk
58. Asia/Shanghai
59. Asia/Kuala_Lumpur
60. Asia/Taipei
61. Australia/Perth
62. Asia/Irkutsk
63. Asia/Seoul
64. Asia/Tokyo
65. Asia/Yakutsk
66. Australia/Darwin
67. Australia/Adelaide
68. Australia/Sydney
69. Australia/Brisbane
70. Australia/Hobart
71. Asia/Vladivostok
72. Pacific/Guam
73. Asia/Magadan
74. Pacific/Fiji
75. Pacific/Auckland
76. Pacific/Tongatapu

Searching for a lead

In order to search for a lead in your contacts database, the following API call needs to be done:

* Required: the CMD parameter must be included in the API call.

** Either the ID or the EMAIL must be passed in order to locate the lead.

Here is an example:

'lead' => [
    'email' => '[email protected]'
],
    'actions' => [
        '0' => [
            'cmd' => 'search_lead'
        ]
]

Success message:

{
  "status":"Success",
  "message":"Lead found",
  "lead_details":
    {
      "id":"39260"
    }
}

Error Cases:

An example of an error message:

{
  "status": "Error",
  "message": "Lead already exists",
  "type": "244"
}