Qodex.ai

List bulk-activated properties

GET https://{{host}}/papi/v1/bulk/activations/:bulkActivationId

List all activations that result from a bulk activation request. Once the overall bulkActivationStatus is COMPLETE, check each activation's activationStatus to confirm it's ACTIVATED. 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.

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.
Acceptstring

RESPONSES

status: OK

{"activatePropertyVersions":[{"acknowledgeAllWarnings":false,"acknowledgeWarnings":["msg_123","msg_234"],"activationStatus":"NEW","activationSubmitDate":"2023-11-22T09:50:18Z","activationUpdateDate":"2023-11-22T09:50:25Z","fastPush":true,"fatalError":"property id is bad or not accessible","network":"PRODUCTION","note":"created by xyz","notifyEmails":["you@example.com","them@example.com"],"propertyId":"prp_3","propertyVersion":11,"taskStatus":"SUBMISSION_ERROR","useFastFallback":false},{"acknowledgeAllWarnings":true,"activationStatus":"NEW","activationSubmitDate":"2023-11-22T09:50:18Z","activationUpdateDate":"2023-11-22T09:50:25Z","fastPush":true,"fatalError":"property id is bad or not accessible","network":"STAGING","note":"Sample activation note","notifyEmails":["you@example.com","them@example.com"],"propertyId":"prp_1","propertyVersion":2,"taskStatus":"SUBMISSION_ERROR","useFastFallback":false},{"acknowledgeAllWarnings":true,"activationStatus":"NEW","activationSubmitDate":"2023-11-22T09:50:18Z","activationUpdateDate":"2023-11-22T09:50:25Z","fastPush":true,"fatalError":"property id is bad or not accessible","network":"STAGING","note":"Sample activation","notifyEmails":["someoneElse@somewhere.com"],"propertyId":"prp_15","propertyVersion":3,"taskStatus":"SUBMISSION_ERROR","useFastFallback":false}],"bulkActivationId":12345,"bulkActivationStatus":"COMPLETE","bulkActivationSubmitDate":"2023-11-22T09:50:18Z","bulkActivationUpdateDate":"2023-11-22T09:50:25Z","defaultActivationSettings":{"acknowledgeAllWarnings":true,"fastPush":true,"notifyEmails":["you@example.com","them@example.com"],"useFastFallback":false}}