Sources
The sources endpoint provides access to a single community's sources.
Request/Response Objects
| Name | Type | Description |
|---|---|---|
| LeadSourceId | int | The unique identifier for the source |
| LeadSourceName | string | Coming Soon! |
| LeadSourceRank | int | The rank of this source, as compared to other sources attributed to this lead. |
| ParentLeadSourceId | int | Coming Soon! |
| ParentLeadSourceName | string | Coming Soon! |
| RootLeadSourceId | int | Coming Soon! |
| RootLeadSourceName | string | Coming Soon! |
Sample GET Requests
https://partner-api.youvegotleads.com/api/properties/95774/sources
https://partner-api.youvegotleads.com/api/properties/95774/sources/5
Sample GET Response (Get all by property)
[
{
"LeadSourceId": 5432,
"LeadSourceName": "LIFESTYLES",
"LeadSourceRank": 0,
"ParentLeadSourceId": 22,
"ParentLeadSourceName": "Direct Mail",
"RootLeadSourceId": 18,
"RootLeadSourceName": "Advertising"
},
{
"LeadSourceId": 5457,
"LeadSourceName": "Sun City Review",
"LeadSourceRank": 0,
"ParentLeadSourceId": 22,
"ParentLeadSourceName": "Direct Mail",
"RootLeadSourceId": 18,
"RootLeadSourceName": "Advertising"
},
{
"LeadSourceId": 5459,
"LeadSourceName": "Doctor's Luncheon",
"LeadSourceRank": 0,
"ParentLeadSourceId": 32,
"ParentLeadSourceName": "Trade Show",
"RootLeadSourceId": 30,
"RootLeadSourceName": "Special Event"
},
{
"LeadSourceId": 5549,
"LeadSourceName": "Home Show",
"LeadSourceRank": 0,
"ParentLeadSourceId": 31,
"ParentLeadSourceName": "On Site Event",
"RootLeadSourceId": 30,
"RootLeadSourceName": "Special Event"
},
{
"LeadSourceId": 5711,
"LeadSourceName": "Seattle Times Sunday Promo",
"LeadSourceRank": 0,
"ParentLeadSourceId": 19,
"ParentLeadSourceName": "Newspaper",
"RootLeadSourceId": 18,
"RootLeadSourceName": "Advertising"
},
{
"LeadSourceId": 5864,
"LeadSourceName": "Senior Gardening ",
"LeadSourceRank": 0,
"ParentLeadSourceId": 31,
"ParentLeadSourceName": "On Site Event",
"RootLeadSourceId": 30,
"RootLeadSourceName": "Special Event"
},
{
"LeadSourceId": 52761,
"LeadSourceName": "Mary Jones",
"LeadSourceRank": 0,
"ParentLeadSourceId": 2,
"ParentLeadSourceName": "Hospital",
"RootLeadSourceId": 1,
"RootLeadSourceName": "Professional"
},
{
"LeadSourceId": 54986,
"LeadSourceName": "Dr. James Waton",
"LeadSourceRank": 0,
"ParentLeadSourceId": 8,
"ParentLeadSourceName": "Physician",
"RootLeadSourceId": 1,
"RootLeadSourceName": "Professional"
},
{
"LeadSourceId": 54987,
"LeadSourceName": "Father Roy",
"LeadSourceRank": 0,
"ParentLeadSourceId": 14,
"ParentLeadSourceName": "Religious Organization",
"RootLeadSourceId": 1,
"RootLeadSourceName": "Professional"
},
{
"LeadSourceId": 54988,
"LeadSourceName": "Marge Atwood",
"LeadSourceRank": 0,
"ParentLeadSourceId": 4,
"ParentLeadSourceName": "Nursing Home",
"RootLeadSourceId": 1,
"RootLeadSourceName": "Professional"
},
{
"LeadSourceId": 54996,
"LeadSourceName": "Mary Jones",
"LeadSourceRank": 0,
"ParentLeadSourceId": 10,
"ParentLeadSourceName": "Home Health",
"RootLeadSourceId": 1,
"RootLeadSourceName": "Professional"
},
{
"LeadSourceId": 60308,
"LeadSourceName": "JANE SMITH",
"LeadSourceRank": 0,
"ParentLeadSourceId": 2,
"ParentLeadSourceName": "Hospital",
"RootLeadSourceId": 1,
"RootLeadSourceName": "Professional"
},
{
"LeadSourceId": 60309,
"LeadSourceName": "MARY JONES",
"LeadSourceRank": 0,
"ParentLeadSourceId": 2,
"ParentLeadSourceName": "Hospital",
"RootLeadSourceId": 1,
"RootLeadSourceName": "Professional"
}
]
Sample GET Response (Get by Source Id - Professional Sources)
[
{
"UpdatedOn": "2010-10-14T00:03:34.427",
"UpdatedBy": "admin",
"Title": "AZ ASSO DIRECTOR",
"SpecialtyId": null,
"SourceStatusId": null,
"ParentLeadSourceId": 2,
"Lname": "JONES",
"LeadSourceName": "MARY JONES",
"LeadSourceId": 60309,
"IsSelectable": true,
"Fname": "MARY",
"CreatedOn": "2010-10-14T00:03:34.427",
"CreatedBy": "admin",
"ContactId": 243634,
"CompanyId": 3945,
"BusinessUnitId": 95774,
"AddressId": 247773,
"Active": true
}
]
Sample GET Response (Get by Source Id - Non-Professional Sources)
[
{
"UpdatedOn": "2010-10-14T00:05:28.34",
"UpdatedBy": "admin",
"ParentLeadSourceId": null,
"LeadSourceName": "Drive By ",
"LeadSourceId": 35,
"IsSelectable": true,
"CreatedOn": "2010-10-14T00:05:28.34",
"CreatedBy": "admin",
"ChildLeadSourceType": "NOCHILD",
"BusinessUnitId": 3,
"Active": true
}
]
Sample POST Requests
Currently, the API only supports posting Professional Sources.
https://partner-api.youvegotleads.com/api/properties/95774/sources
{
"Fname":"Jane",
"Lname":"Doe",
"Title":"Some Job Title",
"Department":"",
"Address1":"2001 Some Street",
"Address2":null,
"City":"Some City",
"State":"TX",
"Zip": "78746",
"HomePhone":null,
"WorkPhone":null,
"CellPhone":null,
"Fax":null,
"Email":"janedoe@somecompany.com",
"Lsid":null,
"SourceId":null,
"SourceStatusId":null,
"Notes":null,
"PropertyId":0,
"ParentId":0,
"PlanId":0,
"OwnershipDate":null,
"ExclusiveDate":null,
"Active":false,
"ContactId":null
}
Sample POST Response
{
"UpdatedOn": "2015-02-09T12:32:18.257",
"UpdatedBy": "Guest5",
"Title": "Some Job Title",
"SpecialtyId": null,
"SourceStatusId": null,
"ParentLeadSourceId": null,
"Lname": "Doe",
"LeadSourceName": "Jane Doe",
"LeadSourceId": 1770157,
"IsSelectable": true,
"Fname": "Jane",
"CreatedOn": "2015-02-09T12:32:18.257",
"CreatedBy": "Guest5",
"ContactId": 47487383,
"CompanyId": 0,
"BusinessUnitId": 95774,
"AddressId": 41405116,
"Active": false
}