Bulk Geo Addressing

Cancels requested job of bulk geocode/verify which is in Scheduled state

This API cancels Scheduled state jobs of bulk geocode/verify.

delete/v1/bulk/jobs/{jobId}

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v1/bulk/jobs/{jobId}
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

jobIdstring required

job id of bulk geocode or verify

Headers

X-Request-Idstring

The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting.

Response

Request received for job cancellation

messagestring

Readable message about the cancel attempt.

jobIdstring nullable

The job ID the cancel was attempted for.

Example response

{
  "message": "Request received for job cancellation",
  "jobId": "8d907c8c-5b63-417f-b69f-2d33dbdd2fcd"
}

Changes

No recorded changes to this operation across all 1 revision of this API.