Request a Demo

A profanity word management method. Returns the custom allow list of the associated license key.

api_key (Required)
Your API application key.
format (Optional)
Response format: xml or json. Defaults to xml.
cdata (Optional)
Set equal to 1 to wrap the listed words in <![CDATA[ ]]>
Use this if you plan on passing strings that may break XML (ie “<” and “&”).
ds (Optional)
Set equal to 1 to show which of the allow list items have “deep search” turned on.
Example XML Response
<?xml version="1.0" encoding="utf-8" ?>
<rsp stat="ok">
Example XML Response with ds=1
<?xml version="1.0" encoding="utf-8" ?>
<rsp stat="ok">
  <word ds="1">word1</word>
  <word ds="0">word2</word>
  <word ds="1">word3</word>
Error Codes
100: Invalid API Key
The API key passed was not valid.
101: API Key is inactive
The API key passed is inactive or has been revoked.
102: API Key was not included in request
This method requires an API Key.
103: Service currently unavailable
The requested service is temporarily unavailable.
HTTP 503
You have exceeded the number of simultaneous requests for your license.
Please go to: to see the limits for your license.