The Lead object

The Lead Object

1 {
2   "id": "string",
3   "remote_id": "string",
4   "created_at": "2023-01-01T00:00:00Z",
5   "modified_at": "2023-01-01T00:00:00Z",
6   "owner": "string",
7   "lead_source": "string",
8   "title": "string",
9   "company": "string",
10   "first_name": "string",
11   "last_name": "string",
12   "addresses": [
13     {
14       "created_at": "2023-01-01T00:00:00Z",
15       "modified_at": "2023-01-01T00:00:00Z",
16       "street_1": "string",
17       "street_2": "string",
18       "city": "string",
19       "state": "string",
20       "postal_code": "string",
21       "country": "AF",
22       "address_type": "BILLING"
23     }
24   ],
25   "email_addresses": [
26     {
27       "created_at": "2023-01-01T00:00:00Z",
28       "modified_at": "2023-01-01T00:00:00Z",
29       "email_address": "string",
30       "email_address_type": "string"
31     }
32   ],
33   "phone_numbers": [
34     {
35       "created_at": "2023-01-01T00:00:00Z",
36       "modified_at": "2023-01-01T00:00:00Z",
37       "phone_number": "string",
38       "phone_number_type": "string"
39     }
40   ],
41   "remote_updated_at": "2023-01-01T00:00:00Z",
42   "remote_created_at": "2023-01-01T00:00:00Z",
43   "converted_date": "2023-01-01T00:00:00Z",
44   "converted_contact": "string",
45   "converted_account": "string",
46   "status": "OPEN",
47   "lead_url": "string",
48   "remote_was_deleted": true,
49   "field_mappings": {
50     "organization_defined_targets": {
51       "string": {}
52     },
53     "linked_account_defined_targets": {
54       "string": {}
55     }
56   },
57   "remote_data": [
58     {
59       "path": "string",
60       "data": {}
61     }
62   ],
63   "remote_fields": [
64     {
65       "remote_field_class": {
66         "id": "string",
67         "display_name": "string",
68         "remote_key_name": "string",
69         "description": "string",
70         "is_custom": true,
71         "is_common_model_field": true,
72         "is_required": true,
73         "field_type": "string",
74         "field_format": "string",
75         "field_choices": [
76           "string"
77         ],
78         "item_schema": {
79           "item_type": "string",
80           "item_format": "string",
81           "item_choices": [
82             "string"
83           ]
84         }
85       },
86       "value": {
87         "string": {}
88       }
89     }
90   ]
91 }

The Lead object is used to represent an individual who is a potential customer.

idstringOptionalRead-onlyformat: "uuid"

remote_idstring or nullOptional

created_atdatetimeOptionalRead-only

The datetime that this object was created by Merge.

modified_atdatetimeOptionalRead-only

The datetime that this object was modified by Merge.

ownerstring or nullOptionalformat: "uuid"

The lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

addresseslist of objectsOptionalRead-only

email_addresseslist of objectsOptionalRead-only

phone_numberslist of objectsOptionalRead-only

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_datedatetime or nullOptional

When the lead was converted.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

statusenum or nullOptional

The lead's status.

Allowed values:

lead_urlstring or nullOptionalformat: "uri"<=2000 characters

The lead's URL in the remote system.

remote_was_deletedbooleanOptionalRead-only

field_mappingsobject or nullOptionalRead-only

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only