Skip to main content
POST
/
tasks
/
{task_id}
/
clean
Clean Task
curl --request POST \
  --url https://api.example.com/tasks/{task_id}/clean \
  --header 'Content-Type: application/json' \
  --data '
{
  "force": false,
  "idle_days": 7
}
'
import requests

url = "https://api.example.com/tasks/{task_id}/clean"

payload = {
"force": False,
"idle_days": 7
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({force: false, idle_days: 7})
};

fetch('https://api.example.com/tasks/{task_id}/clean', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/tasks/{task_id}/clean",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'force' => false,
'idle_days' => 7
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/tasks/{task_id}/clean"

payload := strings.NewReader("{\n \"force\": false,\n \"idle_days\": 7\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/tasks/{task_id}/clean")
.header("Content-Type", "application/json")
.body("{\n \"force\": false,\n \"idle_days\": 7\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/tasks/{task_id}/clean")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"force\": false,\n \"idle_days\": 7\n}"

response = http.request(request)
puts response.read_body
{
  "task_id": "<string>",
  "cleaned_at": "2023-11-07T05:31:56Z",
  "messages_deleted": 123,
  "task_states_deleted": 123,
  "events_deleted": 123
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Path Parameters

task_id
string
required

Body

application/json
force
boolean
default:false

Skip the idle-threshold check. Active-workflow and unprocessed-events checks still apply. Admin use only.

idle_days
integer
default:7

Idle threshold in days (ignored when force=true).

Required range: x >= 1

Response

Successful Response

task_id
string
required
cleaned_at
string<date-time>
required
messages_deleted
integer
required
task_states_deleted
integer
required
events_deleted
integer
required