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

PropertyTypeDescription
idUUIDUnique identifier for the override.
created_dateDateWhen the override was recorded.
updated_dateDateLast modification timestamp.
typeStringExternal object type being overridden, such as person, class, enrollment, or school.
entity_idUUIDPrimary identifier of the entity being overridden.
actionStringOverride action: created, updated, or deleted.
propertiesObjectKey-value pairs of overridden fields.
integration_idUUIDAssociated 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"
}