webpurify.live.addtoallowlist

A profanity word management method. Adds submitted word to the allow list of the associated license key.

Arguments

api_key (Required)

Your API application key.

word (Required)

The word you want added to your allow list.

ds (Optional default = 0)

Deep Search: If you want this word to search substrings. set = 1.

format (Optional)

Response format: xml or json. Defaults to xml.

Example Response

<?xml version="1.0" encoding="utf-8" ?>
<rsp stat="ok">
  <method>webpurify.live.addtoallowlist</method>
  <format>rest</format>
  <success>1</success>
  <api_key>api_key</api_key>
</rsp>

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: http://www.webpurify.com/pricing to see the limits for your license.

105: Word parameter is blank.

The word parameter must have a value