v1Resources/Locations/getRead bulk edit progress

Read bulk edit progress

Returns the progress of a bulk edit started with async: true: status, total, succeeded, failed, skipped and done counts, counts per outcome code, and the locations that failed or were skipped. Only the user who started the job can read it, and a key restricted to specific clients sees only jobs started under those same clients; any other job returns 404.

get/api/v1/locations/bulk-edit-jobs/{id}
locations:read
Query parameters
idstringrequired
Job ID returned by the bulk edit with async: true.
Response
dataobjectoptional
idstringoptional
kindstringoptional
statusstring (queued | running | canceling | completed | partial | failed | canceled)optional
totalintegeroptional
succeededintegeroptional
failedintegeroptional
skippedintegeroptional
doneintegeroptional
codesobjectoptional
problemsarray of objectoptional
targetIdstringoptional
statusstringoptional
codestringoptional
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The location operation needs attention or could not be completed.
get/api/v1/locations/bulk-edit-jobs/{id}
Your API key
id *
{}

Guides that use this resource