VIP Email

Query and manage (add/update/remove) VIP Email data.
EMAIL ADDRESS (i.e. SOMEEMAIL@ABC.COM) and STATUS (i.e. A, R, D, X) values must be upper case

Endpoints

/rpc/v1/vip/email.html: The browsable documentation for this API endpoint.
/rpc/v1/vip/email.json: Endpoint that will return a JSON response.
/rpc/v1/vip/email.xml: Endpoint that will return an XML response.

Usage

Usage for HTTP GET

Key Name: email: Perform a VIP lookup on the provided email.

The status code (review, decline, etc) will be returned for the given email.
Example:
email=EMAIL_ADDRESS
NOTE: Alpha characters in the EMAIL ADDRESS must be in all UPPER CASE

Usage for HTTP POST

Key Name: email[EMAIL_ADDRESS]: Brackets contain an email address. Key values: A|R|D|X for setting status to approve, review, decline, or delete.

Must provide at least one email with a valid status.
Examples:
email[EMAIL_ADDRESS]=A
email[EMAIL_ADDRESS]=R
email[EMAIL_ADDRESS]=D
email[EMAIL_ADDRESS]=X

Some examples using curl are provided below.

Error Codes

206 Partial Success: In batch requests, this signifies that there were a mix of successes and failures.
400 Validation: Incorrect/Invalid input data.
401 Authentication: The key provided could not be authenticated

Response Samples

Successful Response: GET [XML]

<?xml version="1.0" encoding="UTF-8"?>
<response>
 <status>ok</status>
 <count>
  <success>1</success>
  <failure>0</failure>
 </count>
 <errors/>
 <result>decline</result>
</response>

Successful Response: GET [JSON]

{"status":"ok","count":{"success":1,"failure":0},"errors":[],"result":"decline"}

Code Examples

GET

curl -G \
   -d "email=EMAIL_ADDRESS" \
   -H "X-Kount-Api-Key: YYY.XXX.ZZZ" \
   https://api.kount.net/rpc/v1/vip/email.json

POST

curl -d "email[EMAIL_ADDRESS]=D" \
     -H "X-Kount-Api-Key: YYY.XXX.ZZZ" \
     https://api.kount.net/rpc/v1/vip/email.json

POST (batch)

curl -d "email[SOMEEMAIL1@ABC.COM]=D" \
     -d "email[SOMEEMAIL2@ABC.COM]=D" \
     -d "email[SOMEEMAIL3@ABC.COM]=D" \
     -H "X-Kount-Api-Key: YYY.XXX.ZZZ" \
     https://api.kount.net/rpc/v1/vip/email.json