For Developers

Update Team

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

Updates mutable fields on a team. Requires teams.update system permission. Edlink admins and team owners may update additional fields such as mfa_required.

Common Request Body Fields

FieldTypeDescription
namestringTeam display name
aliasstringURL-safe team identifier
descriptionstringTeam description
icon_urlstringTeam icon URL
banner_urlstringTeam banner URL
websitestringPublic website URL
street_addressstringStreet address
citystringCity
statestringState or province
zipstringPostal code
countrystringCountry
technical_contactsstringTechnical contact emails
support_contactsstringSupport contact emails
mfa_requiredbooleanRequire MFA for team members (owners/admins)

Sample Request

const response = await axios.patch(
    `https://ed.link/api/v2/teams/${team_id}`,
    {
        name: 'Edlink University',
        website: 'https://edu.example.com'
    },
    {
        headers: {
            authorization: `Bearer ${user_session_token}`
        }
    }
);

Sample Response

{
    "$data": {
        "id": "d078e26d-9fcc-4f2b-b19f-430891906061",
        "created_date": "2020-02-14T17:20:06.254Z",
        "updated_date": "2026-08-11T18:45:00.000Z",
        "name": "Edlink University",
        "type": "district",
        "state": "active",
        "alias": "edu",
        "website": "https://edu.example.com",
        "verified": true
    }
}