Cancel a Brand job

Stop a Brand job. Items already finished stay readable for 24 hours; items not started are dropped.

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

curl -X POST 'https://rankfield.dev/v1/brand/jobs/8f14e45fceea167a5a36dedd4bea2543/cancel' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

response = requests.post(
    "https://rankfield.dev/v1/brand/jobs/8f14e45fceea167a5a36dedd4bea2543/cancel",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
print(response.json())

const response = await fetch("https://rankfield.dev/v1/brand/jobs/8f14e45fceea167a5a36dedd4bea2543/cancel", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
  },
});
console.log(await response.json());

200

{
  "job": {
    "id": "8f14e45fceea167a5a36dedd4bea2543",
    "status": "canceled",
    "total": 2,
    "done": 1,
    "failed": 0,
    "createdAt": "2026-10-26T18:00:00Z",
    "finishedAt": "2026-10-26T18:00:04Z",
    "expiresAt": "2026-10-27T18:00:04Z"
  }
}

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 Brand job.

Response

The job, now canceled, as in Get a Brand job. Items already running finish; nothing new starts. A job that has already finished is returned unchanged (its status stays done).

Errors

Status	Code	When
401	`unauthorized`	No valid API key.
404		No job with this id for this key, or it has expired. This answer has no `code`: `{"error":{"message":"Not found"}}`.