v1Resources/Locations/postStop a bulk edit job

Stop a bulk edit job

Stops a bulk edit started with async: true. Returns status canceling at once; the job stops between two locations, and edits already made stay made. Read the job for the final counts. Same access rule as reading the job. Returns 409 once the job has finished.

post/api/v1/locations/bulk-edit-jobs/{id}/cancel
locations:write
Query parameters
idstringrequired
Job ID returned by the bulk edit with async: true.
Response
dataobjectoptional
jobIdstringoptional
statusstring (canceling)optional
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.
409The job has already finished, so there is nothing to stop.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The location operation needs attention or could not be completed.
post/api/v1/locations/bulk-edit-jobs/{id}/cancel
Your API key
id *
{}

Guides that use this resource