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.

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 contain the following properties

{
    "identifier": "101",
    "type": "edlink"
}

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: '101',
        type: 'edlink'
    }
});

Sample Response

{
    "$request": "a4eaf191-e54a-4faa-8a94-ac271012bc74",
    "$data": {
        "identifier": "101",
        "type": "edlink"
    }
}