Lead allows users to manage potential customers in Maximizer CRM. See below some considerations for Leads:
-
This folder contains the payloads for what we call Lead V1. For the most recent implementation see Lead V2 folder. If you are creating a new implementation we recommend using Lead V2.\
-
The lead object has some built in functionality that allows converting a Lead entry to an AbEntry. See "Convert Lead" in the HowTo's section for an example of that one.
HowTo's
Convert Lead
// POST https://api.maximizer.com/octopus/PayloadExecute
// Authorization: Bearer <token>
{
"Payload": {
"Data": {
"Source": {
"Lead": {
"Key": "TGVhZAkyMzA5MDcwMDAwMTEzMTk3MTY1MzFMRQkw",
"LastName": "Lead",
"FirstName": "Test",
"CompanyName": "Test company",
"Phone1": {
"Number": ""
},
"Phone2": {
"Number": ""
},
"Email": {
"Address": ""
},
"MrMs": "",
"Salutation": "",
"Position": "Test",
"WebSite": "",
"Status": {
"Value": 0
},
"Address": {
"AddressLine1": "",
"AddressLine2": "",
"City": "",
"Country": "",
"StateProvince": "",
"ZipCode": ""
},
"AbEntryKey": null,
"OpportunityKey": null,
"CampaignKey": null,
"PartnerKey": null,
"AssignedTo": "VXNlcglNQVNURVI=",
"SecAccess": {
"Write": [
{
"Key": {
"UID": "*",
"Value": "VXNlcgkq"
}
}
],
"Read": [
{
"Key": {
"UID": "*",
"Value": "VXNlcgkq"
}
}
]
},
"ArchivedDate": {
"Value": null,
"DisplayValue": null
}
},
"AbEntry": {
"FirstName": "Test",
"LastName": "Lead"
},
"Opportunity": {
"Objective": "Test",
"Description": "Test",
"StartDate": "2023-09-07"
}
},
"Target": {
"Company": {
"Key": null
},
"Contact": {
"Key": null,
"ParentKey": null
},
"Opportunity": {
"Key": null
}
},
"Rules": {
"Company": [
{
"Destination": "/AbEntry/CompanyName",
"Source": "/Lead/CompanyName"
},
{
"Destination": "/AbEntry/AccountManager",
"Source": "/Lead/AssignedTo"
},
{
"Destination": "/AbEntry/PartnerKey",
"Source": "/Lead/PartnerKey"
},
{
"Destination": "/AbEntry/WebSite",
"Source": "/Lead/Website"
},
{
"Destination": "/AbEntry/Address/AddressLine1",
"Source": "/Lead/Address/AddressLine1"
},
{
"Destination": "/AbEntry/Address/AddressLine2",
"Source": "/Lead/Address/AddressLine2"
},
{
"Destination": "/AbEntry/Address/City",
"Source": "/Lead/Address/City"
},
{
"Destination": "/AbEntry/Address/Country",
"Source": "/Lead/Address/Country"
},
{
"Destination": "/AbEntry/Address/StateProvince",
"Source": "/Lead/Address/StateProvince"
},
{
"Destination": "/AbEntry/Address/ZipCode",
"Source": "/Lead/Address/ZipCode"
},
{
"Destination": "/AbEntry/SecAccess/Write",
"Source": "/Lead/SecAccess/Write"
},
{
"Destination": "/AbEntry/SecAccess/Read",
"Source": "/Lead/SecAccess/Read"
}
],
"Contact": [
{
"Destination": "/AbEntry/MrMs",
"Source": "/Lead/MrMs"
},
{
"Destination": "/AbEntry/FirstName",
"Source": "/AbEntry/FirstName"
},
{
"Destination": "/AbEntry/LastName",
"Source": "/AbEntry/LastName"
},
{
"Destination": "/AbEntry/Salutation",
"Source": "/Lead/Salutation"
},
{
"Destination": "/AbEntry/Position",
"Source": "/Lead/Position"
},
{
"Destination": "/AbEntry/Email1/Address",
"Source": "/Lead/Email/Address"
},
{
"Destination": "/AbEntry/AccountManager",
"Source": "/Lead/AssignedTo"
},
{
"Destination": "/AbEntry/PartnerKey",
"Source": "/Lead/PartnerKey"
},
{
"Destination": "/AbEntry/WebSite",
"Source": "/Lead/Website"
},
{
"Destination": "/AbEntry/SecAccess/Write",
"Source": "/Lead/SecAccess/Write"
},
{
"Destination": "/AbEntry/SecAccess/Read",
"Source": "/Lead/SecAccess/Read"
}
],
"Opportunity": [
{
"Destination": "/Opportunity/Objective",
"Source": "/Opportunity/Objective"
},
{
"Destination": "/Opportunity/Description",
"Source": "/Opportunity/Description"
},
{
"Destination": "/Opportunity/CampaignKey",
"Source": "/Lead/CampaignKey"
},
{
"Destination": "/Opportunity/StartDate",
"Source": "/Opportunity/StartDate"
}
]
}
},
"Options": {
"CopyNotes": true,
"CopyDocuments": true
}
},
"Token": "{{Token}}"
}Read - Lead by Phrase
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"Lead": {
"Scope": {
"Fields": {
"Key": {
"Id": 1,
"Value": 1
},
"CompanyName": 1,
"MrMs": 1,
"FirstName": 1,
"MiddleName": 1,
"LastName": 1,
"Salutation": 1,
"Position": 1,
"Email": 1,
"WebSite": 1,
"Status": 1,
"AssignedTo": 1,
"Address": 1,
"Phone1": 1,
"Phone2": 1,
"Creator": 1,
"CreationDate": 1,
"ModifiedBy": 1,
"LastModifyDate": 1,
"FullName": 1,
"AbEntryKey": 1,
"OpportunityKey": 1,
"Source": 1,
"NoEmployees": 1,
"Industry": 1,
"SourceUrl": 1,
"ArchivedDate": 1,
"DisplayValue": 1
}
},
"Criteria": {
"SearchQuery": {
"$PHRASE": "Name: Test"
},
"Top": 1
}
}
}Read - Lead by Key
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"Lead": {
"Scope": {
"Fields": {
"Key": {
"Id": 1,
"Value": 1
},
"CompanyName": 1,
"MrMs": 1,
"FirstName": 1,
"MiddleName": 1,
"LastName": 1,
"Salutation": 1,
"Position": 1,
"Email": 1,
"WebSite": 1,
"Status": 1,
"AssignedTo": 1,
"Address": 1,
"Phone1": 1,
"Phone2": 1,
"Creator": 1,
"CreationDate": 1,
"ModifiedBy": 1,
"LastModifyDate": 1,
"FullName": 1,
"AbEntryKey": 1,
"OpportunityKey": 1,
"Source": 1,
"NoEmployees": 1,
"Industry": 1,
"SourceUrl": 1,
"ArchivedDate": 1,
"DisplayValue": 1
}
},
"Criteria": {
"SearchQuery": {
"Key": {
"$EQ": "TGVhZAkyNDAyMjYwMDAwMDAwMDAxNzMwODNMRQkw"
}
},
"Top": 1
}
}
}MetaData
Read Lead metadata (simple)
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"Schema": {
"Scope": {
"Fields": 1
},
"Criteria": {
"SearchQuery": {
"Key": {
"$TREE": "/Lead"
}
}
}
},
"Compatibility": {
"SchemaObject": "1.0"
}
}Read Lead metadata (more)
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"Schema": {
"Scope": {
"Fields": {
"Key": 1,
"Alias": 1,
"Type": 1,
"Name": 1,
"AppliesTo": 1,
"Sortable": 1,
"Nullable": 1,
"Assignable": 1,
"Queryable": 1,
"Mandatory": 1,
"Attributes": 1,
"HasOption": 1,
"DisplayValue": 1,
"Inactive": 1
}
},
"Criteria": {
"SearchQuery": {
"Key": {
"$TREE": "/Lead"
}
}
}
},
"Compatibility": {
"SchemaObject": "1.0"
}
}FieldOptions
Read Lead FieldOptions - Industry
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
// Applicable to all those properties which have "HasOption": true
"Lead": {
"FieldOptions": {
"Industry": [
{
"Key": 1,
"DisplayValue": 1
}
]
}
},
"Compatibility": {
"SchemaObject": "1.0"
}
}Read Lead FieldOptions - MrMs
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
// Applicable to all those properties which have "HasOption": true
"Lead": {
"FieldOptions": {
"MrMs": [
{
"Key": 1,
"DisplayValue": 1
}
]
}
},
"Compatibility": {
"SchemaObject": "1.0"
}
}Read Lead FieldOptions - Partner
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
// Applicable to all those properties which have "HasOption": true
"Lead": {
"FieldOptions": {
"Partner": [
{
"Key": 1,
"DisplayValue": 1
}
]
}
},
"Compatibility": {
"SchemaObject": "1.0"
}
}Read Lead FieldOptions - Position
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
// Applicable to all those properties which have "HasOption": true
"Lead": {
"FieldOptions": {
"Position": [
{
"Key": 1,
"DisplayValue": 1
}
]
}
},
"Compatibility": {
"SchemaObject": "1.0"
}
}Read Lead FieldOptions - Salutation
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
// Applicable to all those properties which have "HasOption": true
"Lead": {
"FieldOptions": {
"Salutation": [
{
"Key": 1,
"DisplayValue": 1
}
]
}
},
"Compatibility": {
"SchemaObject": "1.0"
}
}Read Lead FieldOptions - Source
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
// Applicable to all those properties which have "HasOption": true
"Lead": {
"FieldOptions": {
"Source": [
{
"Key": 1,
"DisplayValue": 1
}
]
}
},
"Compatibility": {
"SchemaObject": "1.0"
}
}Read Lead FieldOptions - Status
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
// Applicable to all those properties which have "HasOption": true
"Lead": {
"FieldOptions": {
"Status": [
{
"Key": 1,
"DisplayValue": 1
}
]
}
},
"Compatibility": {
"SchemaObject": "1.0"
}
}Lead CRUD
Create - Lead
// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
"Lead": {
"Data": {
"Key": null,
"CompanyName": "E. Brown Enterprises",
"MrMs": "Mr", // Check Field Options
"FirstName": "Marty",
"LastName": "McFly",
"Email": {
"Address": "[email protected]",
"Description": "Main",
"Default": true
},
"WebSite": "https://www.example.com/",
"AssignedTo": {
"UID": "Master"
},
"Status": 1, // Check Field Options
"Address": {
"AddressLine1": "1234 Main St.",
"City": "Anytown",
"StateProvince": "BC",
"ZipCode": "12345",
"Country": "CAN"
},
"Phone1": {
"Default": true,
"Number": "1-800-123-1234",
"Description": "Main",
"Extension": "888"
},
"Source": [ // Check Field Options
"2"
],
"NoEmployees": 6,
"Industry": [ // Check Field Options
"8"
],
"SourceUrl": "https://maximizer.visualstudio.com/Yahoo"
}
}
}Read - Lead
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"Lead": {
"Scope": {
"Fields": {
"Key": {
"ID": 1,
"Number": 1,
"Value": 1
},
"CompanyName": 1,
"MrMs": 1,
"FirstName": 1,
"MiddleName": 1,
"LastName": 1,
"FullName": 1,
"Salutation": 1,
"Position": 1,
"Email": 1,
"WebSite": 1,
"Status": {
"Value": 1,
"key": {
"Id": 1,
"Number": 1,
"Value": 1
},
"DisplayValue": 1
},
"Age": 1,
"AssignedTo": {
"UID": 1,
"Key": 1
},
"Address": {
"AddressLine1": 1,
"AddressLine2": 1,
"City": 1,
"StateProvince": 1,
"Zipcode": 1,
"Country": 1,
"DisplayValue": 1
},
"Phone1": 1,
"Phone2": 1,
"Creator": {
"UID": 1,
"Key": 1
},
"CreationDate": 1,
"ModifiedBy": 1,
"LastModifyDate": 1,
"AbEntryKey": 1,
"OpportunityKey": 1,
"Source": 1,
"NoEmployees": 1,
"Industry": 1,
"SourceUrl": 1
}
},
"Criteria": {
"SearchQuery": {},
"Top": 3
}
}
}Update - Lead
// POST https://api.maximizer.com/octopus/Update
// Authorization: Bearer <token>
{
"Lead": {
"Data": {
"Key": "TGVhZAkyMzA3MDcwMDAyNDA3NzIyMzgxNjlMRQkw", // Mandatory
"CompanyName": "E. Brown Enterprises",
"FirstName": "Emmet",
"LastName": "Brown"
}
}
}Delete - Lead
// POST https://api.maximizer.com/octopus/Delete
// Authorization: Bearer <token>
{
"Lead": {
"Data": {
"Key": "TGVhZAkyMjA2MDcwMDAwNTA3NzIyMzgxNjlMRQkw"
}
}
}