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.update system permission.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
:team_id | UUID | Yes | The ID of the team. |
:onboarding_id | UUID | Yes | The 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
{
"$data": {
"id": "c3600e5f-7da5-4820-9ca9-aa4a1e9793b3",
"deleted": true
}
}