For Developers

Update Alias

PATCH https://ed.link/api/v2/graph/classes/:class_id/assignments/:assignment_id/aliases/:alias_id

This endpoint updates the specified assignment Alias. The original alias value is in the url as :alias_id. The new alias value is in the request body.

ParameterTypeDescription
class_idstringThe UUID of the desired Class.
assignment_idstringThe UUID of the desired Assignment.
alias_idstringThe alias identifier of the desired Alias. in the format of type:identifier

Request Body

The request body should be a JSON object containing an identifier string and a type string.

Like this:

{
    "identifier": "11111",
    "type": "someOtherNamespace"
}

Sample Request

axios.patch(`https://ed.link/api/v2/graph/classes/${class_id}/assignments/${assignment_id}/aliases/${alias_id}`, {
    headers: {
        authorization: `Bearer ${integration_access_token}`
    },
    data: {
        identifier: '11111',
        type: 'someOtherNamespace'
    }
});

Sample Response

{
    "$request": "00000000-0000-0000-0000-000000000000",
    "$data": {
        "identifier": "11111",
        "type": "someOtherNamespace",
        "rule_ids": [],
        "references": {}
    }
}

Supported Providers

  • aeries
  • aspen
  • blackbaud
  • blackboard
  • brightspace
  • canvas
  • classgather
  • facts
  • google
  • illuminate
  • microsoft
  • moodle
  • oneroster
  • powerschool
  • schoology
  • lti
  • skyward
  • veracross
  • qmlativ
  • infinitecampus
  • rapididentity
  • sapphire
  • genesis
  • rediker
  • renweb
  • synergy
  • managebac
  • tyler
  • banner
  • frontline
  • ascender