PATCH https://ed.link/api/v2/teams/:team_id/sources/:source_id
Updates source configuration fields, active state, or attached transformations.
Permissions
Requires either the sources.create or sources.update system permission.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
:team_id | UUID | Yes | The ID of the team. |
:source_id | UUID | Yes | The ID of the source. |
Request Body
| Property | Type | Required | Description |
|---|---|---|---|
name | String | No | Updated display name. |
configuration | Object | No | Updated provider connection parameters and credentials. |
internal | Object | No | Internal configuration flags. |
properties | Object | No | Custom provider settings and feature flags. |
transformation_ids | Array | No | List of transformation IDs attached to this source. |
token | String | No | Updated API access token or refresh token. |
state | String | No | Source operational state (e.g. active, paused, unconfigured). |
Sample Request
const response = await axios.patch(
`https://ed.link/api/v2/teams/${team_id}/sources/${source_id}`,
{
name: 'Oakridge School District - Secondary LMS',
state: 'active'
},
{
headers: {
authorization: `Bearer ${user_session_token}`,
'content-type': 'application/json'
}
}
);
Sample Response
{
"$data": {
"id": "7b5a19cb-9ea8-4b71-9b16-564ec5ea0b12",
"name": "Oakridge School District - Secondary LMS",
"state": "active",
"updated_date": "2024-06-21T11:00:00.000Z"
}
}