curl --request PATCH \
--url https://{host}/primula/api/v3/leads/intended_start_date \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"updates": [
{
"lead_ids": [
"44444444-4444-4444-8444-444444444444"
],
"intended_start_date": "2030-09-01"
}
]
}
'import requests
url = "https://{host}/primula/api/v3/leads/intended_start_date"
payload = { "updates": [
{
"lead_ids": ["44444444-4444-4444-8444-444444444444"],
"intended_start_date": "2030-09-01"
}
] }
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({
updates: [
{
lead_ids: ['44444444-4444-4444-8444-444444444444'],
intended_start_date: '2030-09-01'
}
]
})
};
fetch('https://{host}/primula/api/v3/leads/intended_start_date', 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/intended_start_date",
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([
'updates' => [
[
'lead_ids' => [
'44444444-4444-4444-8444-444444444444'
],
'intended_start_date' => '2030-09-01'
]
]
]),
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/intended_start_date"
payload := strings.NewReader("{\n \"updates\": [\n {\n \"lead_ids\": [\n \"44444444-4444-4444-8444-444444444444\"\n ],\n \"intended_start_date\": \"2030-09-01\"\n }\n ]\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/intended_start_date")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"updates\": [\n {\n \"lead_ids\": [\n \"44444444-4444-4444-8444-444444444444\"\n ],\n \"intended_start_date\": \"2030-09-01\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/primula/api/v3/leads/intended_start_date")
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 \"updates\": [\n {\n \"lead_ids\": [\n \"44444444-4444-4444-8444-444444444444\"\n ],\n \"intended_start_date\": \"2030-09-01\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"updated": [
{
"lead_id": "44444444-4444-4444-8444-444444444444",
"intended_start_date": "2030-09-01"
}
],
"lead_ids_not_updated": []
}Update intended start dates
Requires school_id assigned to the session. At most 200 lead IDs are accepted across all update groups, and duplicates anywhere in the request return 400. Dates must be future YYYY-MM-DD values or TBD. Leads with a CRM/Procare expected start date are not overwritten and are reported in lead_ids_not_updated. Missing lead IDs and leads without raw records are omitted. Per-lead write failures are reported with HTTP 200 in lead_ids_not_updated; a group lookup failure returns 500 after any earlier groups may have been applied.
curl --request PATCH \
--url https://{host}/primula/api/v3/leads/intended_start_date \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"updates": [
{
"lead_ids": [
"44444444-4444-4444-8444-444444444444"
],
"intended_start_date": "2030-09-01"
}
]
}
'import requests
url = "https://{host}/primula/api/v3/leads/intended_start_date"
payload = { "updates": [
{
"lead_ids": ["44444444-4444-4444-8444-444444444444"],
"intended_start_date": "2030-09-01"
}
] }
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({
updates: [
{
lead_ids: ['44444444-4444-4444-8444-444444444444'],
intended_start_date: '2030-09-01'
}
]
})
};
fetch('https://{host}/primula/api/v3/leads/intended_start_date', 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/intended_start_date",
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([
'updates' => [
[
'lead_ids' => [
'44444444-4444-4444-8444-444444444444'
],
'intended_start_date' => '2030-09-01'
]
]
]),
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/intended_start_date"
payload := strings.NewReader("{\n \"updates\": [\n {\n \"lead_ids\": [\n \"44444444-4444-4444-8444-444444444444\"\n ],\n \"intended_start_date\": \"2030-09-01\"\n }\n ]\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/intended_start_date")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"updates\": [\n {\n \"lead_ids\": [\n \"44444444-4444-4444-8444-444444444444\"\n ],\n \"intended_start_date\": \"2030-09-01\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/primula/api/v3/leads/intended_start_date")
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 \"updates\": [\n {\n \"lead_ids\": [\n \"44444444-4444-4444-8444-444444444444\"\n ],\n \"intended_start_date\": \"2030-09-01\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"updated": [
{
"lead_id": "44444444-4444-4444-8444-444444444444",
"intended_start_date": "2030-09-01"
}
],
"lead_ids_not_updated": []
}Authorizations
Access token issued by POST /sessions and associated with a valid server-side session.
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
Update Intended Start Dates Request.
1Show child attributes
Show child attributes