Custom Objects
Update Records by Criteria
Update exstings records by criteria.
PUT
You can update records by criteria using the search_criteria
operator. All parameters that
are not included in the search criteria will be considered as parameters for updating the fields
of records found by the search criteria.
You can use all search operators listed below the request.
Search operators
The request can contain all, some or none of the next search operators:
Operator | Description |
---|---|
lt | Less Than operator Types: integer, float Example: score_value[lt]=1000 |
lte | Less Than or Equal to operator Types: integer, float Example: score_value[lte]=850 |
gt | Greater Than operator Types: integer, float Example: bonus_count[gt]=2.45 |
gte | Greater Than or Equal to operator Types: integer, float Example: bonus_count[gte]=56.443 |
ne | Not Equal to operator Types: integer, float, string, boolean Example: game_mode_name[ne]=ctf |
in | Contained IN array operator Types: integer, float, string Example: game_mode_name[in]=deathmatch,rage |
nin | Not contained IN array operator Types: integer, float, string Example: game_mode_name[nin]=survivor,crazy_nightmare |
all | ALL contained IN array operator Types: array Example: game_modes[all]=survivor,crazy |
or | OR operator Types: integer, float, string Example: name[or]=sam,tim name[or]=sam&lastname[or]=johnson Will return records with name sam or tim . Will return records with name sam or last name johnson . |
ctn | Contains substring operator Types: string Example: username[ctn]=son Will return all records where username field contains son substring. |
near | Types: location Example: mylocation[near]=25.32,44.551;1000 Search records in a specific radius with the current position in meters. Format: {field_name}[near]=longitude,latitude;radius . |
Path Parameters
Custom object class name.
Body Parameters
Update value to the field defined in Custom Object class.
Headers
A user or application session token. See our Authentication page to learn more about session tokens. Must be used either QB-Token or Authorization.
Responses
Was this page helpful?