API – Validate a Filter Expression

action – validfilter

This call is used to validate the syntax of a filter expression for a given Record Type.

Sample Request

{ "account": *** your account id ***, "apikey": "*** your api key ***", "action": "validfilter", "recordtype": "Person", "filter": "First Name is Bob" }

Sample Response

{ "success": true }

If a filter’s syntax is not valid, an error message will state the first issue found in errormsg.

Sample Request

{ "account": *** your account id ***, "apikey": "*** your api key ***", "action": "validfilter", "recordtype": "Person", "filter": "XXX is Bob" }

Sample Response

{ "success": false, "errormsg": "Phrase not understood" }