Bulk patch a set of properties

POST https://{{host}}/papi/v1/bulk/rules-patch-requests

Apply a series of JSON Patch operations to modify a set of property versions. Form this set of patches based on the JSONPath locations from a bulk search response. Specify a set of new property versions based on the results of a bulk versioning operation. The request is a bulk patch object. This operation launches an asynchronous process to update rule trees. To check its progress, run the List bulk-updated properties operation, whose link is available in the Location header or bulkPatchLink member of this operation's response. See Bulk Search and Update for overall guidance on this feature.

Request Params

KeyDatatypeRequiredDescription
contractIdstring(Optional) Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify contractId and groupId independently from each other.
groupIdstring(Optional) Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify contractId and groupId independently from each other.
accountSwitchKeystring(Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Request Body

{"patchPropertyVersions"=>[{"etag"=>"a87v5c65c6821bc", "patches"=>[{"op"=>"replace", "path"=>"/rules/children/1/features/3/option/enabled", "value"=>"on"}, {"op"=>"replace", "path"=>"/rules/children/1/features/0/option/enabled", "value"=>"on"}], "propertyId"=>"prp_1", "propertyVersion"=>1}, {"etag"=>"6c7v5c65c6cvcv65", "patches"=>[{"op"=>"replace", "path"=>"/rules/children/1/children/0/features/1/enabled", "value"=>"on"}], "propertyId"=>"prp_15", "propertyVersion"=>2}, {"etag"=>"1f8903bcde2f3", "patches"=>[{"op"=>"replace", "path"=>"/rules/children/0/children/1/children/2/features/1/enabled", "value"=>"on"}], "propertyId"=>"prp_3", "propertyVersion"=>10}]}

HEADERS

KeyDatatypeRequiredDescription
PAPI-Use-Prefixesstring(Required) Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.
Content-Typestring
Acceptstring