For Developers

Update Transformation

PATCH https://ed.link/api/v2/teams/:team_id/integrations/:integration_id/transformations/:transformation_id

Updates transformation parameters and re-schedules integration materialization.

Permissions

Requires the transformations.update system permission.

Parameters

ParameterTypeRequiredDescription
:team_idUUIDYesThe ID of the team.
:integration_idUUIDYesThe ID of the integration.
:transformation_idUUIDYesThe ID of the transformation.

Request Body

PropertyTypeRequiredDescription
nameStringNoUpdated transformation name.
configurationObjectNoUpdated configuration options.

Sample Request

const response = await axios.patch(
    `https://ed.link/api/v2/teams/${team_id}/integrations/${integration_id}/transformations/${transformation_id}`,
    {
        name: 'Standardize District Student Email'
    },
    {
        headers: {
            authorization: `Bearer ${user_session_token}`,
            'content-type': 'application/json'
        }
    }
);

Sample Response

{
    "$data": {
        "id": "18492019-4819-4bb4-8172-401928472910",
        "name": "Standardize District Student Email"
    }
}