curl --request PUT \
--url https://api.extole.io/v6/batches/{batchId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "name",
"scopes": [
"CLIENT_ADMIN"
],
"tags": [
"tag"
]
}
'import requests
url = "https://api.extole.io/v6/batches/{batchId}"
payload = {
"name": "name",
"scopes": ["CLIENT_ADMIN"],
"tags": ["tag"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'name', scopes: ['CLIENT_ADMIN'], tags: ['tag']})
};
fetch('https://api.extole.io/v6/batches/{batchId}', 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.extole.io/v6/batches/{batchId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'name',
'scopes' => [
'CLIENT_ADMIN'
],
'tags' => [
'tag'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.extole.io/v6/batches/{batchId}"
payload := strings.NewReader("{\n \"name\": \"name\",\n \"scopes\": [\n \"CLIENT_ADMIN\"\n ],\n \"tags\": [\n \"tag\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<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.put("https://api.extole.io/v6/batches/{batchId}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"name\",\n \"scopes\": [\n \"CLIENT_ADMIN\"\n ],\n \"tags\": [\n \"tag\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v6/batches/{batchId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"name\",\n \"scopes\": [\n \"CLIENT_ADMIN\"\n ],\n \"tags\": [\n \"tag\"\n ]\n}"
response = http.request(request)
puts response.read_bodyUpdate a batch job
Updates the mutable fields of an existing batch job: name, tags, and scopes. The job must not be in a terminal state (DONE, FAILED, CANCELED, or EXPIRED). Data source, event name, and column mappings are immutable after creation.
Fields omitted from the body are left unchanged — you do not need to send the whole resource.
curl --request PUT \
--url https://api.extole.io/v6/batches/{batchId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "name",
"scopes": [
"CLIENT_ADMIN"
],
"tags": [
"tag"
]
}
'import requests
url = "https://api.extole.io/v6/batches/{batchId}"
payload = {
"name": "name",
"scopes": ["CLIENT_ADMIN"],
"tags": ["tag"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'name', scopes: ['CLIENT_ADMIN'], tags: ['tag']})
};
fetch('https://api.extole.io/v6/batches/{batchId}', 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.extole.io/v6/batches/{batchId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'name',
'scopes' => [
'CLIENT_ADMIN'
],
'tags' => [
'tag'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.extole.io/v6/batches/{batchId}"
payload := strings.NewReader("{\n \"name\": \"name\",\n \"scopes\": [\n \"CLIENT_ADMIN\"\n ],\n \"tags\": [\n \"tag\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<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.put("https://api.extole.io/v6/batches/{batchId}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"name\",\n \"scopes\": [\n \"CLIENT_ADMIN\"\n ],\n \"tags\": [\n \"tag\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v6/batches/{batchId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"name\",\n \"scopes\": [\n \"CLIENT_ADMIN\"\n ],\n \"tags\": [\n \"tag\"\n ]\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Path Parameters
Batch job ID.
Body
Body of a PUT /v6/batches/{batchId} request.
Updated human-readable label for the batch job. Omit to leave unchanged.
Updated access-control scopes. Accepted values: CLIENT_SUPERUSER, CLIENT_ADMIN. Omit to leave unchanged.
Updated access-control scopes. Accepted values: CLIENT_SUPERUSER, CLIENT_ADMIN. Omit to leave unchanged.
CLIENT_ADMIN, CLIENT_SUPERUSER Updated string labels for filtering and grouping. Replaces the existing tag set. Omit to leave unchanged.
Updated string labels for filtering and grouping. Replaces the existing tag set. Omit to leave unchanged.
Response
Batch job updated. Returns the full updated job record.
