For Developers

Update Application

PATCH https://ed.link/api/v2/teams/:team_id/applications/:application_id

Updates properties of an application. Only modified fields included in the request body are persisted.

Permissions

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

Parameters

ParameterTypeRequiredDescription
:team_idUUIDYesThe ID of the team.
:application_idUUIDYesThe ID of the application.

Request Body

PropertyTypeRequiredDescription
nameStringNoUpdated application name.
descriptionStringNoUpdated application description.
originStringNoUpdated origin domain for CORS/client-side access.
propertiesObjectNoKey-value configuration metadata.
materialization_thresholdsObjectNoCustom record thresholds before materialization runs.

Sample Request

const response = await axios.patch(
    `https://ed.link/api/v2/teams/${team_id}/applications/${application_id}`,
    {
        description: "Updated enterprise integration description",
        origin: "https://secure.acmelearning.com"
    },
    {
        headers: {
            authorization: `Bearer ${user_session_token}`
        }
    }
);

Sample Response

{
    "$data": {
        "id": "7ebf2dc9-ab3b-448f-9b15-0b38e71f81c9",
        "name": "Acme Learning Portal",
        "description": "Updated enterprise integration description",
        "origin": "https://secure.acmelearning.com"
    }
}