Lead

Properties

Properties
lead_id* string Must be a UUID. The unique identifier of the lead.
type* string The lead's entity type, either `individual` or `company`.
id* object,null `null` is allowed. Object containing the lead's identification number, type and country.
date_of_birth* string,null `null` is allowed. The lead's date of birth.
gender* string,null `null` is allowed. The lead's gender (`male` or `female`).
first_name* string The lead's legal first name.
middle_name* string,null `null` is allowed. The lead's legal middle name.
last_name* string The lead's legal last name.
email* string,null `null` is allowed. The lead's contact email address.
cellphone* string,null `null` is allowed. The lead's contact cellphone number.
phone_other* string,null `null` is allowed. The lead's alternative phone number.
created_at* string The time at which the lead was created.
updated_at* string The time at which the lead was updated.
updated_by* object An object indicating the user or API key that updated the lead. See Authentication.
app_data* object,null `null` is allowed. An object containing additional custom data for the lead.
created_by* object An object indicating the user or API key that created the lead. See Authentication.
address* object,null `null` is allowed. The lead's physical address. See below for more details.

Example

{
  "lead_id": "bf1ada91-eecb-4f47-9bfa-1258bb1e0055",
  "type": "individual",
  "first_name": "Erlich",
  "middle_name": "Aviato",
  "last_name": "Bachman",
  "id": {
    "type": "id",
    "number": "6801015800084",
    "country": "ZA"
  },
  "date_of_birth": "1968-01-01",
  "gender": "male",
  "email": "[email protected]",
  "cellphone": null,
  "phone_other": null,
  "created_at": "2017-10-12T15:47:34.281Z",
  "app_data": {
    "company": "Aviato"
  },
  "created_by": {
    "id": "00000000-0000-0000-0000-000000000001",
    "type": "user"
  },
  "address": {
    "line_1": "5230 Penfield Avenue",
    "suburb": "Woodland Hills",
    "city": "Los Angeles",
    "country": "US",
    "area_code": "CA 91364"
  }
}