ICE provides an API that allows vendors to electronically post leads directly to the ICE call center.
ICE API Posting
Posting Information:
| URL | https://iceapi.intakeconversion.com/api/iceapi/create |
| Method | POST |
| Headers | Content-Type : application/json Accept: application/json |
Data Parameters:
The base integration allows for the following fields to be passed using the corresponding Parameters.
| Param | Description - Type - Character Limit |
|---|---|
| First | Required Contact's First Name - string - 50 |
| Last | Required Contact's Last Name - string - 50 |
| Referrer | Required Unique GUID identifying the posting source - GUID |
| Type | Type of Case - GUID |
| Primary | Contact's Primary Number - string - 50 |
| Secondary | Contact's Secondary Number - string - 50 |
| ANI | Caller ID Number - string - 50 |
| Contact's Email - string - 100 | |
| Address | Contact's Address Line 1 - string - 250 |
| City | Contact's City - string - 80 |
| State | Contact's State - string - 2 |
| Zip | Contact's Zip- string - 20 |
| County | Contact's County - string - 50 |
| BestTime | Best Time to reach Contact - string - 100 |
| DOB | Date of Birth - date - 50 |
| Language | Language - string - 50 |
| Details | Details Regarding the lead - multiline string - 4000 |
| Keyword | Transaction Number - string - 50 |
Each posting will require a GUID (Globally Unique Identifier) for the referring source (‘Referrer’). The ‘Referrer’ GUID is a value that identifies your group or site. If you are posting for multiple campaigns you will receive a unique ‘Referrer’ GUID for use with each campaign. This field is mandatory for each posting.
Type (Case Type/Practice Area) GUIDs are also specific to each campaign. The ‘Type’ GUID is not required for posting but should be included when possible.
Example Post:
The JSON code below is only an example. Do not attempt to post with the sample GUIDs or IDs shown.
{
"First": "Gary",
"Last": "Falkowitz",
"Referrer": "3EDE9737-04C0-E611-80E7-005056924C6B",
"Type": "02C52503-BDB2-E611-80E6-005056924C6B",
"Primary": "(855) WITH-ICE",
"Secondary": "(855) 948-4423",
"ANI": "18559484423",
"Email": "[email protected]",
"Address": "1025 Old Country Rd.",
"City": "Westbury",
"State": "NY",
"Zip": "11590",
"County": "Nassau",
"BestTime": "9am",
"DOB": "1/1/1980",
"Language": "English",
"Details": "Details of the case.",
"Keyword": "Lead Number: 56789"
}
The endpoint only accepts a valid JSON structure. Use this JSON validator to make sure your JSON is valid.
Responses:
Below are the different responses the API can return and their respective details.
Message
{
"success": true,
"IntakeID: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
Detail
An intake was created successfully.
{
"success": false,
"error": "JSON syntax error."
}
Invalid JSON data was posted.
{
"success": false,
"error": "Invalid GUID format."
}
Posted JSON data contains a GUID that is not properly formatted.
{
"success": false,
"error": "Referrer/Type GUID does not exist."
}
Posted JSON contains a GUID that does not exist in the client’s ICE organization.
{
"success": false,
"error": "Please provide First"
}
Value for First was not provided in the posted JSON data.
{
"success": false,
"error": "Please provide Last"
}
Value for Last was not provided in the posted JSON data.
{
"success": false,
"error": "Please provide Referrer"
}
GUID for Referrer was not provided in the posted JSON data.