For Developers

Delete Onboarding

DELETE https://ed.link/api/v2/teams/:team_id/onboardings/:onboarding_id

Deletes an onboarding invitation, immediately invalidating any active invitation URLs.

Permissions

Requires the onboardings.delete system permission.

Parameters

ParameterTypeRequiredDescription
:team_idUUIDYesThe ID of the team.
:onboarding_idUUIDYesThe ID of the onboarding invitation to delete.

Sample Request

const response = await axios.delete(`https://ed.link/api/v2/teams/${team_id}/onboardings/${onboarding_id}`, {
    headers: {
        authorization: `Bearer ${user_session_token}`
    }
});

Sample Response

{
    "$request": "00000000-0000-0000-0000-000000000000"
}