API Guide







Select Notifications

Select Notifications allows customers to update the list of blacklists they wish to monitor in an existing profile. This endpoint does not have a PUT method and will replace old blacklist selections with the new POST. Data is returned in the following formats: XML, JSON, CSV and Serialized.

Required headers: X-API-KEY
Optional headers: ACCEPT (json, xml, csv, serialized)
Method: POST

Endpoint URL:

https://api.250ok.com/api/1.0/blacklistinformant/profilenotifications

Sample Output:

{
    "status": "success"
}

Parameters

Parameter Description Acceptable Values Required
profile_id The unique identifier of the monitor summary. NOTE: Profile IDs can be retrieved by executing the Profile Summary API call. Integer Y
emails A comma-separated list of receiving email addresses. String Y
email_blacklisted '1' to notify when monitored items are blacklisted. Boolean N
email_removed '1' to notify when monitored items are removed from blacklists. Boolean N
email_everythingfine '1' to notify when everything is fine. Boolean N
sms A comma-separated list of receiving phone numbers in E.164 format. String Y
sms_blacklisted '1' to notify via SMS when monitored items are blacklisted. Boolean N
sms_removed '1' to notify via SMS when monitored items are removed from blacklists. Boolean N
sms_everythingfine '1' to notify via SMS when everything is fine. Boolean N

Error Responses

Description Code Cause
Invalid profile ID. 404 The unique identifier of the profile is empty or invalid.
Invalid notification preference. 404 Please provide valid SMS number(s) or email address(es).
Invalid email notification type. 404 Please provide email_blacklisted, email_removed, or email_everythingfine.
Invalid SMS notification type. 404 Please provide sms_blacklisted, sms_removed, or sms_everythingfine.
No results found. 403 Forbidden / We couldn't find any results matching your criteria.