Update search filters
Make changes to existing search filters.
sessionId in the response is your session token. Use this token in all the other calls that you make.
Also, make sure that you have the appropriate user type permissions to perform this API call. To view or update your permissions, in WorldServer, go to and then select your user type.
API call
Versioning notes
Starting with WorldServer 11.4, the requests to update search filters require different request bodies, depending on the API version that you use to make the request. For example, the body of the request made to v2 will be different from the body of the request made to v1, as shown in the examples presented later on in this topic.
Details
- PATCH method
- Content-Type in the header:
application/json - Mandatory parameters:
- the session token (as a query string parameter or as a key-value pair in the header)
- the ID of the filter (as a URI parameter)
- a JSON request body that includes at least the following: name, criterion (for v1) or filter (for v2), and resource (only for v2)
Request body example (v1)
Request body example (v2)
Response
OK or Error.
Error messages
| Message | Status code |
|---|---|
| No session token provided or invalid token | 401 Unauthorized |
| You cannot perform the requested action because you do not have permission on other users filters | 400 Bad Request |
| Failed to convert value of type [...] (If the ID you entered is not a valid number.) | 500 Internal Server Error |
| Invalid search filter criterion for field translatedProgress (If the criterion is not defined correctly.) | 500 Internal Server Error |
| Search filter name is not provided | 500 Internal Server Error |