POST api/prospect/save

Back to API Documentation

Once a campaign has been created, the APIKey and Posting instructions can be provided to the Call Center partner. The partner will post prospect data into ISHP using the APIKey provided.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type
AlternatePhone	Optional \| Alternate phone number.	string
APIKey	Required \| Partner Credentials. This value will be provided by the EDDY Account Management team.	globally unique identifier
AreaOfInterest	Optional \| Area of interest.	string
City	Required \| City.	string
Country	Required \| Two-character country code, e.g., "US".	string
Email	Required \| Email address.	string
ExternalSystemId	External system Id.	string
FirstName	Required \| First name.	string
LastName	Required \| Last name.	string
Phone	Required \| Phone number.	string
PostalCode	Required \| Postal code or Zip code.	string
ProspectInitiatingUrl	Required \| Valid URL where the prospect was initiated.	string
ProspectSourceUrl	Required \| Valid URL where the prospect was generated (CallCenter URL).	string
State	Required \| Two-character US state abbreviation, e.g., "NJ".	string
YearHighestEducationCompleted	Year Highest Education was completed.	integer

Request Format

Conten-Type: application/json

            {
             "apiKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
             "firstName": "Testfirst",
             "lastname": "Testlast",
             "address": "801 test Corner Ct",
             "address2": "apt a",
             "city": "Green Bay",
             "postalcode": "55555",
             "state": "WI",
             "country": "US",
             "email": "test@test.com",
             "phone": "5555555555",
             "alternatePhone": "5555555555",
             "yearHighestEducationCompleted": "1978",
             "externalSystemId": "123"
             "prospectSourceUrl": "https://www.EducationDynamics.com/lead"
             "prospectInitiatingUrl": "https://www.EducationDynamics.com/start"
            }

Response Information

Output

        {
             "IsSuccessful": true,
             "Body": {
                 "ProspectId": 8787805,
                 "ProspectFlowId": 10959192
                 },
             "ResponseDateTime": "2017-01-31T16:02:33.9357698-05:00",
             "RequestDateTime": "2017-01-31T16:02:07.5655017-05:00",
             "ResponseGuid": "6fc82d18-1f2e-4a1b-8fa6-36573a56f695",
             "Messages": [
                     {
                     "MessageCode": "msg0038",
                     "Message": "Validation Passed."
                     }
                 ],
             "TotalResponseTime": 13
             }