Updates mutable fields while the job is awaiting_confirmation.
PATCH
/
v1
/
ingestion
/
jobs
/
{job_id}
import olira
olira.init(api_key="YOUR_API_KEY")
job = olira.patch_ingestion_job(
job_id="ing-job-001",
summary_types=["symptom_snapshot", "emotional_state_snapshot"],
)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var job = OliraModule.PatchIngestionJob(
jobId: "ing-job-001",
summaryTypes: ["symptom_snapshot", "emotional_state_snapshot"]);
PATCH /v1/ingestion/jobs/ing-job-001
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"summary_types": ["symptom_snapshot", "emotional_state_snapshot"]
}
IngestionJob(
job_id="ing-job-001",
status="awaiting_confirmation",
summary_types=["symptom_snapshot", "emotional_state_snapshot"],
)
{
"error": true,
"status_code": 401,
"error_type": "authentication_error",
"message": "Could not validate credentials",
"details": [
{
"type": "authentication_error",
"message": "Could not validate credentials"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 403,
"error_type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint",
"details": [
{
"type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 404,
"error_type": "not_found_error",
"message": "Patient not found",
"details": [
{
"type": "not_found_error",
"message": "Patient not found"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 422,
"error_type": "validation_error",
"message": "Request validation failed (1 error)",
"details": [
{
"type": "missing",
"message": "Field required",
"field": "patient_id",
"location": ["body", "patient_id"],
"input_value": null
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 429,
"error_type": "server_error",
"message": "Rate limit exceeded",
"details": [
{
"type": "rate_limit",
"message": "Too many requests; retry after backoff"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 500,
"error_type": "internal_server_error",
"message": "An internal server error occurred",
"details": [
{
"type": "internal_server_error",
"message": "An unexpected error occurred while processing your request"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
olira.patch_ingestion_job(
job_id: str,
summary_types: list[str] | None = None,
) -> IngestionJob
OliraModule.PatchIngestionJob(
string jobId,
IReadOnlyList<string>? summaryTypes = null,
) // -> IngestionJob
sdk:historical-ingest
Use summary_types to choose which views are backfilled before confirming.
Parameters
str
required
Job id in awaiting_confirmation.
list[str] | None
summary_type identifiers from your org’s active view templates.
Returns
IngestionJob
str
Job id.
list[str] | None
Updated backfill selection.
Raises
| Exception | When |
|---|---|
AuthError | HTTP 401 or 403 — invalid API key or insufficient OAuth scope for this endpoint. |
ValidationError | HTTP 400, 404, or 422 — malformed JSON, unknown patient, or validation failure (message includes response excerpt). |
ServerError | HTTP 409 (e.g. conflicting external identifier) or repeated 5xx after retries; includes status_code when applicable. |
RateLimitError | HTTP 429 — rate limited; check retry_after (seconds). |
NetworkError | Connection timeout, DNS failure, or read error after retries. |
import olira
olira.init(api_key="YOUR_API_KEY")
job = olira.patch_ingestion_job(
job_id="ing-job-001",
summary_types=["symptom_snapshot", "emotional_state_snapshot"],
)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var job = OliraModule.PatchIngestionJob(
jobId: "ing-job-001",
summaryTypes: ["symptom_snapshot", "emotional_state_snapshot"]);
PATCH /v1/ingestion/jobs/ing-job-001
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"summary_types": ["symptom_snapshot", "emotional_state_snapshot"]
}
IngestionJob(
job_id="ing-job-001",
status="awaiting_confirmation",
summary_types=["symptom_snapshot", "emotional_state_snapshot"],
)
{
"error": true,
"status_code": 401,
"error_type": "authentication_error",
"message": "Could not validate credentials",
"details": [
{
"type": "authentication_error",
"message": "Could not validate credentials"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 403,
"error_type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint",
"details": [
{
"type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 404,
"error_type": "not_found_error",
"message": "Patient not found",
"details": [
{
"type": "not_found_error",
"message": "Patient not found"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 422,
"error_type": "validation_error",
"message": "Request validation failed (1 error)",
"details": [
{
"type": "missing",
"message": "Field required",
"field": "patient_id",
"location": ["body", "patient_id"],
"input_value": null
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 429,
"error_type": "server_error",
"message": "Rate limit exceeded",
"details": [
{
"type": "rate_limit",
"message": "Too many requests; retry after backoff"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 500,
"error_type": "internal_server_error",
"message": "An internal server error occurred",
"details": [
{
"type": "internal_server_error",
"message": "An unexpected error occurred while processing your request"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
⌘I
import olira
olira.init(api_key="YOUR_API_KEY")
job = olira.patch_ingestion_job(
job_id="ing-job-001",
summary_types=["symptom_snapshot", "emotional_state_snapshot"],
)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var job = OliraModule.PatchIngestionJob(
jobId: "ing-job-001",
summaryTypes: ["symptom_snapshot", "emotional_state_snapshot"]);
PATCH /v1/ingestion/jobs/ing-job-001
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"summary_types": ["symptom_snapshot", "emotional_state_snapshot"]
}
IngestionJob(
job_id="ing-job-001",
status="awaiting_confirmation",
summary_types=["symptom_snapshot", "emotional_state_snapshot"],
)
{
"error": true,
"status_code": 401,
"error_type": "authentication_error",
"message": "Could not validate credentials",
"details": [
{
"type": "authentication_error",
"message": "Could not validate credentials"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 403,
"error_type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint",
"details": [
{
"type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 404,
"error_type": "not_found_error",
"message": "Patient not found",
"details": [
{
"type": "not_found_error",
"message": "Patient not found"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 422,
"error_type": "validation_error",
"message": "Request validation failed (1 error)",
"details": [
{
"type": "missing",
"message": "Field required",
"field": "patient_id",
"location": ["body", "patient_id"],
"input_value": null
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 429,
"error_type": "server_error",
"message": "Rate limit exceeded",
"details": [
{
"type": "rate_limit",
"message": "Too many requests; retry after backoff"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 500,
"error_type": "internal_server_error",
"message": "An internal server error occurred",
"details": [
{
"type": "internal_server_error",
"message": "An unexpected error occurred while processing your request"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}