Hoover's API Version 4.0 - Personalization
Queries - SOAP - Personalization Information
IMPORTANT: All calls on this page require an Username, Password, and an API key
New features are highlighted.
1 Create User Note
1.1 Overview
Creates the note for a particular company.
1.2 Input Parameters
Required fields are indicated with.
Field Name | Value | Notes |
uniqueId | Hoovers Company ID -OR- DUNS Number | |
noteText | Note text. | Should be less than 1000 characters. |
noteDate | Date on the note. | Note Date can be in the past. It's different from note created date. Format should be YYYY-MM-DD and the year should be between 1900 and 2099. |
1.3 Output Parameters
Field Name | Value | Notes |
/CreateUserNoteResponse/message | Detailed message on success or failure |
2 Update User Note
2.1 Overview
Update the note for a particular company.
2.2 Input Parameters
Required fields are indicated with.
Field Name | Value | Notes |
uniqueId | Hoovers Company ID -OR- DUNS Number | |
noteText | Note text. | Should be less than 1000 characters. Either noteDate or noteText is required. |
noteDate | Date on the note. | Note Date can be in the past. It's different from note created date. Either noteDate or noteText is required. Format should be YYYY-MM-DD and year should be between 1900 and 2099. |
2.3 Output Parameters
Field Name | Value | Notes |
/UpdateUserNoteResponse/message | Detailed message on success or failure |
3 Delete User Note
3.1 Overview
Deletes a note.
3.2 Input Parameters
Required fields are indicated with.
Field Name | Value | Notes |
noteId | ID of the Note to be deleted. |
3.3 Output Parameters
Field Name | Value | Notes |
/DeleteUserNoteResponse/message | Detailed message on success or failure |
4 Get User Note
4.1 Overview
Retrieves a single a company note.
4.2 Input Parameters
Required fields are indicated with.
Field Name | Value | Notes |
noteId | ID of the Note to be retrieved. |
4.3 Output Parameters
Field Name | Value | Notes |
/GetUserNoteResponse/return/companyId | The id of the company that is tied to the note. | |
/GetUserNoteResponse/return/noteId | The id of the note. | |
/GetUserNoteResponse/return/noteText | The text of the note. | |
/GetUserNoteResponse/return/noteDate | The date of the note. |
5 Find Notes
5.1 Overview
Allows searching for company notes using different criteria.
5.2 Input Parameters
Required fields are indicated with.
Field Name | Value | Notes |
uniqueId | Hoovers Company ID -OR- DUNS Number | |
dateFrom | Note date lower bound | |
dateTo | Note date upper bound | |
maxRecords | Max records | Between 1-200. Default = 20 |
hitOffset | Greater than or equal to 0 but less than or equal to 10,000. Default = 0 | Paging support, the firstHit returned will be hitOffset + 1. hitOffset is now zero-based. |
5.3 Output Parameters
Field Name | Value | Notes |
/FindUserNotesResponse/notes/firstHit | First hit number in the response | |
/FindUserNotesResponse/notes/hits | Number of hits in the response | |
/FindUserNotesResponse/notes/lastHit | Last hit number in the response | |
/FindUserNotesResponse/notes/totalHits | Total number of hits found | |
/FindUserNotesResponse/notes/hit/hitNumber | Hit number | |
/FindUserNotesResponse/notes/hit/noteResults/companyId | The id of the company that is tied to the note. | |
/FindUserNotesResponse/notes/hit/noteResults/noteId | The id of the note. | |
/FindUserNotesResponse/notes/hit/noteResults/noteText | The text of the note. | |
/FindUserNotesResponse/notes/hit/noteResults/noteDate | The date of the note. |
6 Get Credit Counts
6.1 Overview
Returns the credit details for a given user.
6.2 Input Parameters
Required fields are indicated with.
Field Name | Value | Notes |
No parameters |
6.3 Output Parameters
Field Name | Value | Notes |
/connectMailCredits/creditsPurchased | Total connect mail credits purchased | |
/connectMailCredits/creditsUsed | Connect mail credits used | |
/connectMailCredits/creditsRemaining | Connect mail credits remaining |
7 Create a User Contact
7.1 Overview
Creates the contact for a particular user.
7.2 Input Parameters
Required fields are indicated with.
Field Name | Value | Notes |
uniqueId | Hoovers Company ID -OR- DUNS Number | |
coOfficialId | CoOfficial Id | |
title | title of the person. | |
address1 | Address 1. | |
address2 | Address 2. | |
city | City. | |
stateOrProvince | State or Province. | |
postalCode | Postal Code. | |
country | Country name. | |
mainPhone | Main Phone Number. | |
directPhone | Direct Phone. | |
mobilePhone | Mobile Phone. | |
nickname | Nick name. | |
workEmail | Work Email. | |
personalEmail | Personal Email. |
7.3 Output Parameters
Field Name | Value | Notes |
/return/message | Friendly message on success. |
8 Update a User Contact
8.1 Overview
Update the contact for a particular user.
8.2 Input Parameters
Required fields are indicated with.
Field Name | Value | Notes |
contactId | Id of the Contact | Contact Id or (CompanyId and CoOfficialId) is required |
uniqueId | Hoovers Company ID -OR- DUNS Number | Contact Id or (CompanyId and CoOfficialId) is required |
coOfficialId | CoOfficial Id | Contact Id or (CompanyId and CoOfficialId) is required |
title | title of the person. | |
address1 | Address 1. | |
address2 | Address 2. | |
city | City. | |
stateOrProvince | State or Province. | |
postalCode | Postal Code. | |
country | Country name. | |
mainPhone | Main Phone Number. | |
directPhone | Direct Phone. | |
mobilePhone | Mobile Phone. | |
nickname | Nick name. | |
workEmail | Work Email. | |
personalEmail | Personal Email. |
8.3 Output Parameters
Field Name | Value | Notes |
/return/message | Friendly message on success. |
9 Find User Contacts
9.1 Overview
Find the contacts for a particular user.
9.2 Input Parameters
Required fields are indicated with.
Field Name | Value | Notes |
companyName | company name of the contacts you are searching | |
maxRecords | maximum number of records to be returned in the results | defaults to 20. maxRecords should be less than 200. |
hitOffset | specify the starting record number. | if hitOffset is 5 and maxRecords is 20. You will see 5th contact through 25th contact, provided 25 contacts matches your criteria. |
people/firstName | firstName of the contact you are searching for | |
people/lastName | lastName of the contact you are searching for | |
people/nickName | nickName of the contact you are searching for | |
people/title | title of the contact you are searching for | |
location/city | city of the contact you are searching for | |
location/stateOrProvince | state or province of the contact you are searching for | |
location/country | country of the contact you are searching for | |
location/postalCode | postal code of the contact you are searching for | |
filters/uniqueId | unique company id of the contact you are searching for |
9.3 Output Parameters
Field Name | Value | Notes |
/contact/firstHit | first Hit number. | if the hitOffset is 0, then firstHit is 1 |
/contact/lastHit | last record number. | |
/contact/hits | total records returned in this search. | |
/contact/totalHits | total number of contacts matching the criteria | |
/contact/hit/hitNumber | result number | |
/contact/hit/ContactResult/contactId | id of the contact | |
/contact/hit/ContactResult/coOfficialId | official id of the contact | |
/contact/hit/ContactResult/companyId | companyId of the contact | |
/contact/hit/ContactResult/duns | duns id of the contact | |
/contact/hit/ContactResult/companyName | company name to which the contact belongs | |
/contact/hit/ContactResult/people/firstName | firstName of the contact | |
/contact/hit/ContactResult/people/lastName | last name of the contact | |
/contact/hit/ContactResult/people/nickName | nick name of the contact | |
/contact/hit/ContactResult/people/title | title of the contact | |
/contact/hit/ContactResult/customContactData/city | city | |
/contact/hit/ContactResult/customContactData/stateOrProvince | state or province | |
/contact/hit/ContactResult/customContactData/country | country |
10 Get User Contact
10.1 Overview
Get the contact for the given contactId or (companyId or CoOfficialId).
10.2 Input Parameters
Required fields are indicated with.
Field Name | Value | Notes |
contactId | contactId of the contact you are searching | |
coOfficialInfo/uniqueId | companyId of the contact you are searching | |
coOfficialInfo/coOfficialId | coOfficialId of the contact you are searching |
10.3 Output Parameters
Field Name | Value | Notes |
/contact/contactId | id of the contact | |
/contact/coOfficialId | official id of the contact | |
/contact/companyId | companyId of the contact | |
/contact/companyName | company name to which the contact belongs | |
/contact/people/firstName | firstName of the contact | |
/contact/people/middleName | middleName of the contact | |
/contact/people/lastName | last name of the contact | |
/contact/people/nickName | nick name of the contact | |
/contact/people/title | title of the contact | |
/contact/customContactData/city | city | |
/contact/customContactData/stateOrProvince | state or province | |
/contact/customContactData/country | country | |
/contact/customContactData/address1 | Address1 of the contact | |
/contact/customContactData/address2 | Address2 of the contact | |
/contact/customContactData/postalCode | PostalCode of the contact | |
/contact/customContactData/mainPhone | mainPhone of the contact | |
/contact/customContactData/directPhone | directPhone of the contact | |
/contact/customContactData/mobilePhone | mobilePhone of the contact | |
/contact/customContactData/workEmail | workEmail of the contact | |
/contact/customContactData/personalEmail | personalEmail of the contact |
11 Delete User Contact
11.1 Overview
Delete the contact for the given contactId or (companyId or CoOfficialId).
11.2 Input Parameters
Required fields are indicated with.
Field Name | Value | Notes |
contactId | contactId of the contact you are deleting | |
coOfficialInfo/uniqueId | companyId of the contact you are deleting | |
coOfficialInfo/coOfficialId | coOfficialId of the contact you are deleting |
11.3 Output Parameters
Field Name | Value | Notes |
/return/message | Friendly message on success. |
- Versions
- Version 3.0
- Version 3.1
- Version 3.2
- Version 3.3
- Version 3.4
- Version 4.0
- Version 4.0 Documentation
- Overview
- Security
- SOAP Services
- Queries - Company Information
- Queries - Person Information
- Queries - Industry Information
- Queries - Lookup Information
- Queries - Personalization
- REST Services
- Personalization