For Developers
Overrides Overview
A Shared Override allows administrators to manually alter or supplement educational data for an integration without modifying the source SIS or LMS. Overrides can replace user roles, reassign schools, or override emails.
A delete override removes the record from shared data on every sync until you delete the override. It does not force a reimport. To bring the record back, delete the override.
Properties
| Property | Type | Description |
|---|---|---|
id | UUID | Unique identifier for the override. |
created_date | Date | When the override was recorded. |
updated_date | Date | Last modification timestamp. |
type | String | External object type being overridden, such as person, class, enrollment, or school. |
entity_id | UUID | Primary identifier of the entity being overridden. |
action | String | Override action: created, updated, or deleted. |
properties | Object | Key-value pairs of overridden fields. |
integration_id | UUID | Associated integration identifier. |
JSON Example
{
"id": "90184b23-9041-4712-8819-102938475819",
"type": "person",
"entity_id": "4a18dc60-5ff0-482a-9e1e-28ebc9735d10",
"action": "updated",
"properties": {
"email": "principal.anderson@oakridge.k12.org",
"role": "administrator"
},
"integration_id": "fd8e2612-1329-4d85-bb56-95dcb27d7c92"
}
