List bulk-patched properties

get

https://{hostname}/papi/v1/bulk/rules-patch-requests/{bulkPatchId}

List all modified property versions that result from a bulk patch request. This operation polls the asynchronous process's status. Once the overall bulkPatchStatus is COMPLETE, you can feed all successfully updated property versions whose status is UPDATED into a subsequent request to bulk activate them. See Bulk Search and Update for overall guidance on this feature.

Path Params

bulkPatchId

integer

required

Identifies each bulk patch job.

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.

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

`bulkPatchStatus` is `COMPLETE`.

Language

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200The response shows the bulk update job, which proceeds until the bulkPatchStatus is COMPLETE.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

429Too many requests.

500Internal server error.

`bulkPatchStatus` is `COMPLETE`.