Tenant credential
curl --request POST 'https://api.printools.io/v1/tasks/bulk/update' \
--header 'X-API-Key: $PRINTOOLS_API_KEY' \
--header 'Content-Type: application/json' \
--data '{"target":{"ids":["11111111-2222-3333-4444-555555555555"],"filters":[{"field":"example","op":"example","value":"example","values":["example"],"from":"example","to":"example"}],"search":"example","excludeIds":["11111111-2222-3333-4444-555555555555"]},"input":{"status":"example","assignedToEmail":"example","assignedToName":"example","dueDate":"2026-09-07"}}'import requests
url = "https://api.printools.io/v1/tasks/bulk/update"
payload = {
"target": {
"ids": ["11111111-2222-3333-4444-555555555555"],
"filters": [
{
"field": "example",
"op": "example",
"value": "example",
"values": ["example"],
"from": "example",
"to": "example"
}
],
"search": "example",
"excludeIds": ["11111111-2222-3333-4444-555555555555"]
},
"input": {
"status": "example",
"assignedToEmail": "example",
"assignedToName": "example",
"dueDate": "2026-09-07"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
target: {
ids: ['11111111-2222-3333-4444-555555555555'],
filters: [
{
field: 'example',
op: 'example',
value: 'example',
values: ['example'],
from: 'example',
to: 'example'
}
],
search: 'example',
excludeIds: ['11111111-2222-3333-4444-555555555555']
},
input: {
status: 'example',
assignedToEmail: 'example',
assignedToName: 'example',
dueDate: '2026-09-07'
}
})
};
fetch('https://api.printools.io/v1/tasks/bulk/update', 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.printools.io/v1/tasks/bulk/update",
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([
'target' => [
'ids' => [
'11111111-2222-3333-4444-555555555555'
],
'filters' => [
[
'field' => 'example',
'op' => 'example',
'value' => 'example',
'values' => [
'example'
],
'from' => 'example',
'to' => 'example'
]
],
'search' => 'example',
'excludeIds' => [
'11111111-2222-3333-4444-555555555555'
]
],
'input' => [
'status' => 'example',
'assignedToEmail' => 'example',
'assignedToName' => 'example',
'dueDate' => '2026-09-07'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.printools.io/v1/tasks/bulk/update"
payload := strings.NewReader("{\n \"target\": {\n \"ids\": [\n \"11111111-2222-3333-4444-555555555555\"\n ],\n \"filters\": [\n {\n \"field\": \"example\",\n \"op\": \"example\",\n \"value\": \"example\",\n \"values\": [\n \"example\"\n ],\n \"from\": \"example\",\n \"to\": \"example\"\n }\n ],\n \"search\": \"example\",\n \"excludeIds\": [\n \"11111111-2222-3333-4444-555555555555\"\n ]\n },\n \"input\": {\n \"status\": \"example\",\n \"assignedToEmail\": \"example\",\n \"assignedToName\": \"example\",\n \"dueDate\": \"2026-09-07\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.printools.io/v1/tasks/bulk/update")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"target\": {\n \"ids\": [\n \"11111111-2222-3333-4444-555555555555\"\n ],\n \"filters\": [\n {\n \"field\": \"example\",\n \"op\": \"example\",\n \"value\": \"example\",\n \"values\": [\n \"example\"\n ],\n \"from\": \"example\",\n \"to\": \"example\"\n }\n ],\n \"search\": \"example\",\n \"excludeIds\": [\n \"11111111-2222-3333-4444-555555555555\"\n ]\n },\n \"input\": {\n \"status\": \"example\",\n \"assignedToEmail\": \"example\",\n \"assignedToName\": \"example\",\n \"dueDate\": \"2026-09-07\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.printools.io/v1/tasks/bulk/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"target\": {\n \"ids\": [\n \"11111111-2222-3333-4444-555555555555\"\n ],\n \"filters\": [\n {\n \"field\": \"example\",\n \"op\": \"example\",\n \"value\": \"example\",\n \"values\": [\n \"example\"\n ],\n \"from\": \"example\",\n \"to\": \"example\"\n }\n ],\n \"search\": \"example\",\n \"excludeIds\": [\n \"11111111-2222-3333-4444-555555555555\"\n ]\n },\n \"input\": {\n \"status\": \"example\",\n \"assignedToEmail\": \"example\",\n \"assignedToName\": \"example\",\n \"dueDate\": \"2026-09-07\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "OK",
"data": {
"requested": 123,
"affected": 123,
"refused": 123,
"failed": 123,
"outcomes": [
{
"id": "<string>",
"status": "ok",
"reason": "<string>"
}
]
}
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}Tasks
Patch every production task matching a target
Requires the scope tasks.write.
POST
/
v1
/
tasks
/
bulk
/
update
Tenant credential
curl --request POST 'https://api.printools.io/v1/tasks/bulk/update' \
--header 'X-API-Key: $PRINTOOLS_API_KEY' \
--header 'Content-Type: application/json' \
--data '{"target":{"ids":["11111111-2222-3333-4444-555555555555"],"filters":[{"field":"example","op":"example","value":"example","values":["example"],"from":"example","to":"example"}],"search":"example","excludeIds":["11111111-2222-3333-4444-555555555555"]},"input":{"status":"example","assignedToEmail":"example","assignedToName":"example","dueDate":"2026-09-07"}}'import requests
url = "https://api.printools.io/v1/tasks/bulk/update"
payload = {
"target": {
"ids": ["11111111-2222-3333-4444-555555555555"],
"filters": [
{
"field": "example",
"op": "example",
"value": "example",
"values": ["example"],
"from": "example",
"to": "example"
}
],
"search": "example",
"excludeIds": ["11111111-2222-3333-4444-555555555555"]
},
"input": {
"status": "example",
"assignedToEmail": "example",
"assignedToName": "example",
"dueDate": "2026-09-07"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
target: {
ids: ['11111111-2222-3333-4444-555555555555'],
filters: [
{
field: 'example',
op: 'example',
value: 'example',
values: ['example'],
from: 'example',
to: 'example'
}
],
search: 'example',
excludeIds: ['11111111-2222-3333-4444-555555555555']
},
input: {
status: 'example',
assignedToEmail: 'example',
assignedToName: 'example',
dueDate: '2026-09-07'
}
})
};
fetch('https://api.printools.io/v1/tasks/bulk/update', 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.printools.io/v1/tasks/bulk/update",
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([
'target' => [
'ids' => [
'11111111-2222-3333-4444-555555555555'
],
'filters' => [
[
'field' => 'example',
'op' => 'example',
'value' => 'example',
'values' => [
'example'
],
'from' => 'example',
'to' => 'example'
]
],
'search' => 'example',
'excludeIds' => [
'11111111-2222-3333-4444-555555555555'
]
],
'input' => [
'status' => 'example',
'assignedToEmail' => 'example',
'assignedToName' => 'example',
'dueDate' => '2026-09-07'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.printools.io/v1/tasks/bulk/update"
payload := strings.NewReader("{\n \"target\": {\n \"ids\": [\n \"11111111-2222-3333-4444-555555555555\"\n ],\n \"filters\": [\n {\n \"field\": \"example\",\n \"op\": \"example\",\n \"value\": \"example\",\n \"values\": [\n \"example\"\n ],\n \"from\": \"example\",\n \"to\": \"example\"\n }\n ],\n \"search\": \"example\",\n \"excludeIds\": [\n \"11111111-2222-3333-4444-555555555555\"\n ]\n },\n \"input\": {\n \"status\": \"example\",\n \"assignedToEmail\": \"example\",\n \"assignedToName\": \"example\",\n \"dueDate\": \"2026-09-07\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.printools.io/v1/tasks/bulk/update")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"target\": {\n \"ids\": [\n \"11111111-2222-3333-4444-555555555555\"\n ],\n \"filters\": [\n {\n \"field\": \"example\",\n \"op\": \"example\",\n \"value\": \"example\",\n \"values\": [\n \"example\"\n ],\n \"from\": \"example\",\n \"to\": \"example\"\n }\n ],\n \"search\": \"example\",\n \"excludeIds\": [\n \"11111111-2222-3333-4444-555555555555\"\n ]\n },\n \"input\": {\n \"status\": \"example\",\n \"assignedToEmail\": \"example\",\n \"assignedToName\": \"example\",\n \"dueDate\": \"2026-09-07\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.printools.io/v1/tasks/bulk/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"target\": {\n \"ids\": [\n \"11111111-2222-3333-4444-555555555555\"\n ],\n \"filters\": [\n {\n \"field\": \"example\",\n \"op\": \"example\",\n \"value\": \"example\",\n \"values\": [\n \"example\"\n ],\n \"from\": \"example\",\n \"to\": \"example\"\n }\n ],\n \"search\": \"example\",\n \"excludeIds\": [\n \"11111111-2222-3333-4444-555555555555\"\n ]\n },\n \"input\": {\n \"status\": \"example\",\n \"assignedToEmail\": \"example\",\n \"assignedToName\": \"example\",\n \"dueDate\": \"2026-09-07\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "OK",
"data": {
"requested": 123,
"affected": 123,
"refused": 123,
"failed": 123,
"outcomes": [
{
"id": "<string>",
"status": "ok",
"reason": "<string>"
}
]
}
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}Required scopes:
tasks.write.Authorizations
tenantApiKeypartnerApiKey & partnerApiSecret & partnerBearer
Tenant credential. This is sufficient by itself.
Headers
Tenant credential: optional and, when sent, must equal the shop bound to the key. Partner credential: required; it selects an organisation the user previously authorised.
Optional client-generated key for write retries. Reusing it with a different request returns 409; a replay includes Idempotency-Replayed: true.
Required string length:
1 - 200Body
application/json
A bulk selection, as it travels to a bulk mutation. Exactly ONE branch is
populated: ids for hand-picked rows (the common case), or the filter branch
(filters / search / excludeIds) for "select all matching". Supplying both
is a validation error rather than a silent reconciliation.
The filter branch reuses the SAME ListFilterInput the list query was issued
with, so bulk never grows a second filter language, and excludeIds carries the
rows the operator un-ticked while select-all-matching was on.
The filter branch is RE-EVALUATED AT EXECUTION TIME: a row created between the
operator ticking select-all-matching and confirming IS included. That is the
honest meaning of "everything matching this filter", and it is why a confirm
dialog must show bulkTargetCount's answer rather than a client-side tally.
Shared across list services.
Show child attributes
Show child attributes
Fields a bulk production-task update may set. Omitted = untouched.
Show child attributes
Show child attributes
Response
Successful response.
Every 2xx response uses this envelope.
The actual resolver result. It can be false when an operation returns false or null without throwing.
Example:
"OK"
The one shape every bulk mutation answers in, so the client renders one summary.
requested is what the target RESOLVED to on the server, not what the client
guessed. refused and failed are counted separately on purpose: a rule
declining a row (an AS Colour garment, a draft purchase order) is not a failure,
and collapsing the two makes correct behaviour read as breakage.
Shared across list services.
Show child attributes
Show child attributes
Was this page helpful?