PATCH https://ed.link/api/v2/teams/:team_id/onboardings/:onboarding_id
Associates an application with a pending or started onboarding invitation.
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. |
Request Body
| Property | Type | Required | Description |
|---|---|---|---|
application_id | UUID | Yes | Application ID to attach to this onboarding. |
Sample Request
const response = await axios.patch(
`https://ed.link/api/v2/teams/${team_id}/onboardings/${onboarding_id}`,
{
application_id: '035d6dd6-1569-47b2-8ed8-63435be58078'
},
{
headers: {
authorization: `Bearer ${user_session_token}`,
'content-type': 'application/json'
}
}
);
Sample Response
{
"$data": {
"id": "c3600e5f-7da5-4820-9ca9-aa4a1e9793b3",
"application_id": "035d6dd6-1569-47b2-8ed8-63435be58078",
"updated_date": "2026-07-16T10:00:00.000Z"
}
}