Create Job Instruction Page
curl --request POST \
--url https://api.example.com/api/public/v1/instructions/jobs/{jobId}/pages \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"parentPageId": {},
"content": {},
"beforePageId": "<string>",
"afterPageId": "<string>",
"position": 123,
"preflightToken": "<string>",
"confirmLive": {}
}
'import requests
url = "https://api.example.com/api/public/v1/instructions/jobs/{jobId}/pages"
payload = {
"title": "<string>",
"parentPageId": {},
"content": {},
"beforePageId": "<string>",
"afterPageId": "<string>",
"position": 123,
"preflightToken": "<string>",
"confirmLive": {}
}
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({
title: '<string>',
parentPageId: {},
content: {},
beforePageId: '<string>',
afterPageId: '<string>',
position: 123,
preflightToken: '<string>',
confirmLive: {}
})
};
fetch('https://api.example.com/api/public/v1/instructions/jobs/{jobId}/pages', 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",
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([
'title' => '<string>',
'parentPageId' => [
],
'content' => [
],
'beforePageId' => '<string>',
'afterPageId' => '<string>',
'position' => 123,
'preflightToken' => '<string>',
'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"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"parentPageId\": {},\n \"content\": {},\n \"beforePageId\": \"<string>\",\n \"afterPageId\": \"<string>\",\n \"position\": 123,\n \"preflightToken\": \"<string>\",\n \"confirmLive\": {}\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/api/public/v1/instructions/jobs/{jobId}/pages")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"parentPageId\": {},\n \"content\": {},\n \"beforePageId\": \"<string>\",\n \"afterPageId\": \"<string>\",\n \"position\": 123,\n \"preflightToken\": \"<string>\",\n \"confirmLive\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/public/v1/instructions/jobs/{jobId}/pages")
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 \"title\": \"<string>\",\n \"parentPageId\": {},\n \"content\": {},\n \"beforePageId\": \"<string>\",\n \"afterPageId\": \"<string>\",\n \"position\": 123,\n \"preflightToken\": \"<string>\",\n \"confirmLive\": {}\n}"
response = http.request(request)
puts response.read_bodyInstructions
Create Job Instruction Page
Create a rich page directly in a job’s Instructions tab.
POST
/
api
/
public
/
v1
/
instructions
/
jobs
/
{jobId}
/
pages
Create Job Instruction Page
curl --request POST \
--url https://api.example.com/api/public/v1/instructions/jobs/{jobId}/pages \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"parentPageId": {},
"content": {},
"beforePageId": "<string>",
"afterPageId": "<string>",
"position": 123,
"preflightToken": "<string>",
"confirmLive": {}
}
'import requests
url = "https://api.example.com/api/public/v1/instructions/jobs/{jobId}/pages"
payload = {
"title": "<string>",
"parentPageId": {},
"content": {},
"beforePageId": "<string>",
"afterPageId": "<string>",
"position": 123,
"preflightToken": "<string>",
"confirmLive": {}
}
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({
title: '<string>',
parentPageId: {},
content: {},
beforePageId: '<string>',
afterPageId: '<string>',
position: 123,
preflightToken: '<string>',
confirmLive: {}
})
};
fetch('https://api.example.com/api/public/v1/instructions/jobs/{jobId}/pages', 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",
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([
'title' => '<string>',
'parentPageId' => [
],
'content' => [
],
'beforePageId' => '<string>',
'afterPageId' => '<string>',
'position' => 123,
'preflightToken' => '<string>',
'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"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"parentPageId\": {},\n \"content\": {},\n \"beforePageId\": \"<string>\",\n \"afterPageId\": \"<string>\",\n \"position\": 123,\n \"preflightToken\": \"<string>\",\n \"confirmLive\": {}\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/api/public/v1/instructions/jobs/{jobId}/pages")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"parentPageId\": {},\n \"content\": {},\n \"beforePageId\": \"<string>\",\n \"afterPageId\": \"<string>\",\n \"position\": 123,\n \"preflightToken\": \"<string>\",\n \"confirmLive\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/public/v1/instructions/jobs/{jobId}/pages")
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 \"title\": \"<string>\",\n \"parentPageId\": {},\n \"content\": {},\n \"beforePageId\": \"<string>\",\n \"afterPageId\": \"<string>\",\n \"position\": 123,\n \"preflightToken\": \"<string>\",\n \"confirmLive\": {}\n}"
response = http.request(request)
puts response.read_bodyCreates a canonical root page or one-level subpage. Requires
The response returns the canonical page, checksum, employer URL, and whether
the idempotency key replayed an earlier create.
instructions:write, employer access, and an Idempotency-Key header.
string
required
Page title, from 1 to 200 characters.
string | null
A root page ID. A subpage cannot be used as a parent.
object
A complete TipTap
doc node. Omit for an empty page.string
Place the new page immediately before this sibling. Use at most one placement field.
string
Place the new page immediately after this sibling. Use at most one placement field.
integer
Place the page at this zero-based sibling index. Use at most one placement field.
string
required
The short-lived token returned by preflighting this exact create operation.
true
required
Confirms that the new page is immediately visible to hired AI trainers.
⌘I