POST https://ed.link/api/v2/teams/:team_id/onboardings
Creates a new onboarding invitation for an application or data source.
Permissions
Requires the onboardings.update system permission.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
:team_id | UUID | Yes | The ID of the team. |
Request Body
| Property | Type | Required | Description |
|---|---|---|---|
application_id | UUID | Yes (for developers) | The application to integrate. Required for developer teams. |
source_id | UUID | Yes (for districts) | The data source to connect. Restricted to district teams. |
institution_id | UUID | No | Target educational institution (requires verified team). |
company_id | UUID | No | Target company or vendor (requires verified team). |
provider_id | UUID | No | Pre-selected provider ID. |
automatic_approval | Boolean | No | Whether created integrations should be automatically approved. |
expiration_date | Date | No | Invitation expiry timestamp. |
redirect_uri | String | No | URL to redirect administrators to upon completion. |
Sample Request
const response = await axios.post(
`https://ed.link/api/v2/teams/${team_id}/onboardings`,
{
application_id: '035d6dd6-1569-47b2-8ed8-63435be58078',
automatic_approval: true,
redirect_uri: 'https://acmelearning.com/app/onboarding-complete'
},
{
headers: {
authorization: `Bearer ${user_session_token}`,
'content-type': 'application/json'
}
}
);
Sample Response
{
"$data": {
"id": "c3600e5f-7da5-4820-9ca9-aa4a1e9793b3",
"created_date": "2026-07-01T14:00:00.000Z",
"state": "pending",
"application_id": "035d6dd6-1569-47b2-8ed8-63435be58078",
"automatic_approval": true
}
}