Lead Gen & CRM has a distinct API organization. This article will detail the parts of the Lead Gen & CRM API related to leads.
| Administrators | ✓ | |
| Company Managers | ||
| Marketing Managers | ||
| Sales Managers | ||
| Salespersons | ||
| Jr. Salespersons |
A lead is a prospect who is possibly interested in your product. As a lead progresses through your pipeline, their status changes from unqualified to qualified. A lead can be converted into a contact, opportunity, or account.
If you wish to update custom fields for a lead, specify the custom field's systemName as the key in your lead object. In order to get a list of system names, first retrieve members of the Field table.
|
|
Name | Type | Length | Is Required |
| id | bigint | 20 | Optional | |
| accountID | bigint | 20 | Optional | |
| ownerID | bigint | 20 | Optional | |
| campaignID | bigint | 20 | Optional | |
| leadStatus | picklist | Optional | ||
| leadScore | smallint | 6 | Optional | |
| leadScoreWeighted | smaillint | 6 | Optional | |
| persona | string | 128 | Optional | |
| active | tinyint | 1 | Optional | |
| firstName | varchar | 50 | Optional | |
| lastName | varchar | 50 | Optional | |
| emailAddress | varchar | 150 | Required | |
| companyName | varchar | 100 | Optional | |
| title | varchar | 255 | Optional | |
| street | varchar | 255 | Optional | |
| city | varchar | 255 | Optional | |
| country | varchar | 255 | Optional | |
| state | varchar | 50 | Optional | |
| zipcode | varchar | 50 | Optional | |
| website | varchar | 255 | Optional | |
| phoneNumber | varchar | 255 | Optional | |
| trackingID | varchar | 255 | Optional | |
| officePhoneNumber | varchar | 255 | Optional | |
| phoneNumberExtension | varchar | 255 | Optional | |
| mobilePhoneNumber | varchar | 255 | Optional | |
| faxNumber | varchar | 255 | Optional | |
| description | text | Optional | ||
| industry | varchar | 255 | Optional | |
| isUnsubscribed | tinyint | 1 | Optional | |
| updateTimestamp | timestamp | Optional |
Contains metadata for a Lead Gen & CRM field. This includes both lead and opportunity fields. The systemName is a key that can be specified in any POST to create or update an object.
|
|
Name | Type | Length | Is Required |
| id | int | 18 | Optional | |
| relationship | varchar | 255 | Required | |
| systemName | varchar | 255 | Optional | |
| label | varchar | 255 | Required | |
| source | varchar | 255 | Optional | |
| dataType | varchar | 255 | Required | |
| dataLength | int | 18 | Required | |
| isRequired | tinyint | 1 | Required | |
| isCustom | tinyint | 1 | Required | |
| isActive | tinyint | 1 | Required | |
| isAvailableInContactManager | tinyint | 1 | Required | |
| isEditableInContactManager | tinyint | 1 | Required | |
| isAvailableInForms | tinyint | 1 | Required |
This article details specific schema content about Lead Gen & CRM's API. However, given the size and scope of the API, information is broken up and is contained in different articles. Each article focuses on a specific function of Lead Gen & CRM's API. Additional API information can be found in the following articles:
Copyright © 2025 · All Rights Reserved · Constant Contact · Privacy Center