Replace Job Instruction Page
curl --request PUT \
--url https://api.example.com/api/public/v1/instructions/jobs/{jobId}/pages/{pageId} \
--header 'Content-Type: application/json' \
--data '
{
"content": {},
"expectedChecksum": "<string>",
"confirmReplace": {},
"confirmLive": {}
}
'import requests
url = "https://api.example.com/api/public/v1/instructions/jobs/{jobId}/pages/{pageId}"
payload = {
"content": {},
"expectedChecksum": "<string>",
"confirmReplace": {},
"confirmLive": {}
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({content: {}, expectedChecksum: '<string>', confirmReplace: {}, confirmLive: {}})
};
fetch('https://api.example.com/api/public/v1/instructions/jobs/{jobId}/pages/{pageId}', 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/api/public/v1/instructions/jobs/{jobId}/pages/{pageId}",
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([
'content' => [
],
'expectedChecksum' => '<string>',
'confirmReplace' => [
],
'confirmLive' => [
]
]),
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/api/public/v1/instructions/jobs/{jobId}/pages/{pageId}"
payload := strings.NewReader("{\n \"content\": {},\n \"expectedChecksum\": \"<string>\",\n \"confirmReplace\": {},\n \"confirmLive\": {}\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/api/public/v1/instructions/jobs/{jobId}/pages/{pageId}")
.header("Content-Type", "application/json")
.body("{\n \"content\": {},\n \"expectedChecksum\": \"<string>\",\n \"confirmReplace\": {},\n \"confirmLive\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/public/v1/instructions/jobs/{jobId}/pages/{pageId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"content\": {},\n \"expectedChecksum\": \"<string>\",\n \"confirmReplace\": {},\n \"confirmLive\": {}\n}"
response = http.request(request)
puts response.read_bodyInstructions
Replace Job Instruction Page
Replace a complete canonical TipTap document with concurrency and live-write guards.
PUT
/
api
/
public
/
v1
/
instructions
/
jobs
/
{jobId}
/
pages
/
{pageId}
Replace Job Instruction Page
curl --request PUT \
--url https://api.example.com/api/public/v1/instructions/jobs/{jobId}/pages/{pageId} \
--header 'Content-Type: application/json' \
--data '
{
"content": {},
"expectedChecksum": "<string>",
"confirmReplace": {},
"confirmLive": {}
}
'import requests
url = "https://api.example.com/api/public/v1/instructions/jobs/{jobId}/pages/{pageId}"
payload = {
"content": {},
"expectedChecksum": "<string>",
"confirmReplace": {},
"confirmLive": {}
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({content: {}, expectedChecksum: '<string>', confirmReplace: {}, confirmLive: {}})
};
fetch('https://api.example.com/api/public/v1/instructions/jobs/{jobId}/pages/{pageId}', 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/api/public/v1/instructions/jobs/{jobId}/pages/{pageId}",
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([
'content' => [
],
'expectedChecksum' => '<string>',
'confirmReplace' => [
],
'confirmLive' => [
]
]),
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/api/public/v1/instructions/jobs/{jobId}/pages/{pageId}"
payload := strings.NewReader("{\n \"content\": {},\n \"expectedChecksum\": \"<string>\",\n \"confirmReplace\": {},\n \"confirmLive\": {}\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/api/public/v1/instructions/jobs/{jobId}/pages/{pageId}")
.header("Content-Type", "application/json")
.body("{\n \"content\": {},\n \"expectedChecksum\": \"<string>\",\n \"confirmReplace\": {},\n \"confirmLive\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/public/v1/instructions/jobs/{jobId}/pages/{pageId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"content\": {},\n \"expectedChecksum\": \"<string>\",\n \"confirmReplace\": {},\n \"confirmLive\": {}\n}"
response = http.request(request)
puts response.read_bodyReplaces the complete page document. Requires
A stale checksum returns
instructions:write and
employer access. Preview the content first.
object
required
The complete TipTap
doc node.string
required
The SHA-256 checksum from the last page read.
true
required
Confirms the whole-document replacement.
true
required
Confirms immediate worker visibility.
409 instead of overwriting a concurrent edit.⌘I