This API cancels Scheduled state jobs of bulk geocode/verify.
DELETE https://hostname/v1/bulk/jobs/{jobId}
Request
Path parameters
| Key | Required | Type | Description |
|---|---|---|---|
| jobId | Yes | string |
job id of bulk geocode or verify |
Header keys
| Key | Required | Type | Description |
|---|---|---|---|
| X-Request-Id | No | string | 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
The API returns a JSON object confirming that the cancellation request has been received
Response body properties
| Property | Type | Description |
|---|---|---|
| jobId | string | Unique identifier of the job for which the cancellation request was submitted. |
| message | string | A confirmation message indicating that the cancellation request has been received and is being processed. |
Response examples
Example status code responses for this method are shown here.
{
"jobId": "fdb25e89-30c0-4fdb-b2b8-2c6e24736ad9",
"message": "Request received for job cancellation"
}{
"errors": [
{
"status": "BAD_REQUEST",
"errorMessage": "Invalid Job Id (DIS-LI-1051)"
}
]
}{
"errors": [
{
"status": "INVALID_TOKEN",
"errorMessage": "Unauthorized (DIS-1001)"
}
]
}{
"errors": [
{
"status": "FORBIDDEN",
"errorMessage": "You do not have permission to access this API (DIS-1002)"
}
]
}{
"errors": [
{
"status": "TOO_MANY_REQUESTS",
"errorMessage": "Rate limit exceeded (DIS-1005)"
}
]
}{
"errors": [
{
"status": "INTERNAL_ERROR",
"errorMessage": "Issue with internal services. Please try again after sometime (DIS-1003)"
}
]
}