Cancel a suggest job

Stop a running suggest job. Keywords already finished stay readable; the rest end with status 499.

POSThttps://rankfield.dev/v1/bing/suggest/jobs/{id}/cancel

curl -X POST 'https://rankfield.dev/v1/bing/suggest/jobs/1e3aff33-2831-4112-b934-cb727ab6c23a/cancel' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

response = requests.post(
    "https://rankfield.dev/v1/bing/suggest/jobs/1e3aff33-2831-4112-b934-cb727ab6c23a/cancel",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
print(response.json())

const response = await fetch("https://rankfield.dev/v1/bing/suggest/jobs/1e3aff33-2831-4112-b934-cb727ab6c23a/cancel", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
  },
});
console.log(await response.json());

200

{
  "id": "1e3aff33-2831-4112-b934-cb727ab6c23a",
  "status": "cancelled",
  "total": 2,
  "completed": 2,
  "succeeded": 1,
  "failed": 1,
  "createdAt": 1792938856915,
  "deadlineAt": 1792938916915,
  "completedAt": 1792938857066,
  "delivery": "priority",
  "keywordCount": 2,
  "workUnits": 2
}

Parameters

Headers

Name	Type	Required	Default	Description
`Authorization`	string	Yes	–	`Bearer` followed by your API key. See Authentication.

Path parameters

Name	Type	Required	Default	Description
`id`	string	Yes	–	The job id from Start a suggest job.

Response

The job, as in Get a suggest job. A job that has already finished is returned unchanged.

Errors

Status	When
401	No valid API key.
404	No job with this id for this key.