ICE API Posting

ICE provides an API that allows vendors to electronically post leads directly to the ICE call center.

Posting Information:

URLhttps://iceapi.intakeconversion.com/api/iceapi/create
Method
POST
HeadersContent-Type : application/json
Accept: application/json

Data Parameters:

The base integration allows for the following fields to be passed using the corresponding Parameters.

ParamDescription - Type - Character Limit
FirstRequired Contact's First Name - string - 50
LastRequired Contact's Last Name - string - 50
ReferrerRequired Unique GUID identifying the posting source - GUID
TypeType of Case - GUID
PrimaryContact's Primary Number - string - 50
SecondaryContact's Secondary Number - string - 50
ANICaller ID Number - string - 50
EmailContact's Email - string - 100
AddressContact's Address Line 1 - string - 250
CityContact's City - string - 80
StateContact's State - string - 2
ZipContact's Zip- string - 20
CountyContact's County - string - 50
BestTimeBest Time to reach Contact - string - 100
DOBDate of Birth - date - 50
LanguageLanguage - string - 50
DetailsDetails Regarding the lead - multiline string - 4000
KeywordTransaction 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.