For Developers

Update Rule

PATCH https://ed.link/api/v2/teams/:team_id/integrations/:integration_id/rules/:rule_id

Updates rule definitions and schedules a materialization to apply the new criteria.

Permissions

Requires either the rules.create or rules.update system permission.

Parameters

ParameterTypeRequiredDescription
:team_idUUIDYesThe ID of the team.
:integration_idUUIDYesThe ID of the integration.
:rule_idUUIDYesThe ID of the rule.

Request Body

PropertyTypeRequiredDescription
nameStringNoUpdated rule name.
stateStringNodraft, suggested, or active.
conditionsArrayNoReplacement conditions. Each needs target, property, operator, and values. Omit this key to leave existing conditions in place.
start_dateDateNoRule start.
end_dateDateNoRule end.
soft_capNumberNoSoft license cap.
hard_capNumberNoHard license cap.
product_idsArrayNoProducts this licensing rule applies to.

Sample Request

const response = await axios.patch(
    `https://ed.link/api/v2/teams/${team_id}/integrations/${integration_id}/rules/${rule_id}`,
    {
        name: 'Exclude Inactive Students'
    },
    {
        headers: {
            authorization: `Bearer ${user_session_token}`,
            'content-type': 'application/json'
        }
    }
);

Sample Response

{
    "$data": {
        "id": "7ca194a2-1982-4f91-8841-59128aa10234",
        "name": "Exclude Inactive Students"
    }
}