For Developers
Create Override
POST https://ed.link/api/v2/teams/:team_id/integrations/:integration_id/overrides
Creates a new override and schedules an integration materialization.
Permissions
Requires the overrides.create system permission.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
:team_id | UUID | Yes | The ID of the team. |
:integration_id | UUID | Yes | The ID of the integration. |
Request Body
| Property | Type | Required | Description |
|---|---|---|---|
type | String | Yes | External object type, such as person, class, enrollment, or school. |
entity_id | UUID | Conditional | Required for updated and deleted; generated by the API for created. |
action | String | Yes | created, updated, or deleted. |
properties | Object | No | Map of overridden field names and values. |
Sample Request
const response = await axios.post(
`https://ed.link/api/v2/teams/${team_id}/integrations/${integration_id}/overrides`,
{
type: 'person',
entity_id: '4a18dc60-5ff0-482a-9e1e-28ebc9735d10',
action: 'updated',
properties: {
email: 'principal.anderson@oakridge.k12.org'
}
},
{
headers: {
authorization: `Bearer ${user_session_token}`,
'content-type': 'application/json'
}
}
);
Sample Response
{
"$data": {
"id": "90184b23-9041-4712-8819-102938475819",
"type": "person",
"entity_id": "4a18dc60-5ff0-482a-9e1e-28ebc9735d10",
"action": "updated"
}
}
