curl --request PATCH \
--url https://{host}/primula/api/v3/leads/{id}/stages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"stage_tour_completed": true
}
'import requests
url = "https://{host}/primula/api/v3/leads/{id}/stages"
payload = { "stage_tour_completed": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({stage_tour_completed: true})
};
fetch('https://{host}/primula/api/v3/leads/{id}/stages', 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://{host}/primula/api/v3/leads/{id}/stages",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'stage_tour_completed' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{host}/primula/api/v3/leads/{id}/stages"
payload := strings.NewReader("{\n \"stage_tour_completed\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://{host}/primula/api/v3/leads/{id}/stages")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"stage_tour_completed\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/primula/api/v3/leads/{id}/stages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"stage_tour_completed\": true\n}"
response = http.request(request)
puts response.read_body[
{
"stage": "stage_tour_completed",
"value": "Yes",
"updated_at": "2026-01-15T09:30:00Z"
}
]Update lead stages
Requires school_id assigned to the session and at least one non-null boolean stage. Unknown properties return 400. Stages are written in the documented schema order. Each stage is a separate write: a later failure returns 404/500 and earlier stages may remain applied; an error response does not include a partial stage list. On success the current stages are read back.
curl --request PATCH \
--url https://{host}/primula/api/v3/leads/{id}/stages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"stage_tour_completed": true
}
'import requests
url = "https://{host}/primula/api/v3/leads/{id}/stages"
payload = { "stage_tour_completed": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({stage_tour_completed: true})
};
fetch('https://{host}/primula/api/v3/leads/{id}/stages', 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://{host}/primula/api/v3/leads/{id}/stages",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'stage_tour_completed' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{host}/primula/api/v3/leads/{id}/stages"
payload := strings.NewReader("{\n \"stage_tour_completed\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://{host}/primula/api/v3/leads/{id}/stages")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"stage_tour_completed\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/primula/api/v3/leads/{id}/stages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"stage_tour_completed\": true\n}"
response = http.request(request)
puts response.read_body[
{
"stage": "stage_tour_completed",
"value": "Yes",
"updated_at": "2026-01-15T09:30:00Z"
}
]Authorizations
Access token issued by POST /sessions and associated with a valid server-side session.
Path Parameters
UUID identifying this resource.
Query Parameters
Company UUID. Must equal the authenticated session company when that session has a company assigned; the equality check is skipped for sessions without one.
School UUID. Must be assigned to the authenticated session.
Body
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Update Lead Stages Request.
true sets the stage, false clears it; omitted or null leaves it unchanged.
true sets the stage, false clears it; omitted or null leaves it unchanged.
true sets the stage, false clears it; omitted or null leaves it unchanged.
true sets the stage, false clears it; omitted or null leaves it unchanged.
true sets the stage, false clears it; omitted or null leaves it unchanged.
true sets the stage, false clears it; omitted or null leaves it unchanged.
Response
Successful response.