For Developers

Links Overview

A Link connects a primary source (such as an SIS) with a secondary source (such as an LMS). Linked sources can cross-populate missing identifiers, email addresses, or demographic metadata through automated enrichment runs.

Properties

PropertyTypeDescription
idUUIDUnique identifier for the link.
created_dateDateDate when the link was created.
updated_dateDateLast modification timestamp.
primary_source_idUUIDThe source receiving enriched records.
secondary_source_idUUIDThe supporting source providing supplementary fields.
priorityNumberPrecedence order when resolving conflicting field values.
permissionsArrayPermission scopes allowed to cross-reference data.
propertiesObjectLink configuration settings and matching rules.

JSON Example

{
    "id": "d132a0c4-954f-4d32-8ea7-a36c93427db9",
    "created_date": "2024-03-01T10:00:00.000Z",
    "updated_date": "2024-06-20T12:00:00.000Z",
    "primary_source_id": "7b5a19cb-9ea8-4b71-9b16-564ec5ea0b12",
    "secondary_source_id": "1c7a216b-4e09-4d24-8f47-c0e815617a22",
    "priority": 1,
    "permissions": []
}