Bulk patch a set of properties

post

https://{hostname}/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.

Query Params

contractId

string

Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify contractId and groupId independently from each other.

groupId

string

Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify contractId and groupId independently from each other.

accountSwitchKey

string

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.

Body Params

Encapsulates customized JSON patch instructions to run on a set of JSON path locations within various property versions' rule trees. See Bulk Search and Update for guidance on this feature.

patchPropertyVersions

array of objects

required

Specifies JSON patch instructions to modify each property version.

patchPropertyVersions*

Headers

PAPI-Use-Prefixes

string

enum

required

Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

202The response links the bulk patch process.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

415Unsupported media type.

429Too many requests.

500Internal server error.