Skip to main content
POST
/
image
/
task
/
cancel
/
{taskId}
Cancel a task
curl --request POST \
  --url https://whilter-api-host/image/task/cancel/{taskId} \
  --header 'Authorization: Bearer <token>'
{
  "client-id": "<string>",
  "campaign-id": "<string>",
  "template-id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task-id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message": "Task cancelled successfully"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
taskId
string<uuid>
required

The unique identifier of the task to cancel

Response

Task cancelled successfully

​
client-id
string

Client ID provided during vendor onboarding

​
campaign-id
string

Identifier for the campaign

​
template-id
string<uuid>

Unique identifier for the template to use

​
task-id
string<uuid>

Unique identifier for the created task

​
message
string

Response message

Example:

"Task cancelled successfully"