PATCH https://ed.link/api/v2/teams/:team_id/integrations/:integration_id
Updates integration configuration properties, data sharing scopes, and rate limits.
Permissions
Requires either the integrations.create or integrations.update system permission.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
:team_id | UUID | Yes | The ID of the team. |
:integration_id | UUID | Yes | The ID of the integration. |
Request Body
| Property | Type | Required | Description |
|---|---|---|---|
permissions | Array | No | Updated array of permission UUIDs. |
scope | Object | No | Scope filtering configuration. |
properties | Object | No | Custom integration properties. |
transformation_ids | Array | No | Active transformation IDs attached to this integration. |
district_sharing | String | No | District data sharing mode (all, rules, or none). |
developer_sharing | String | No | Developer data sharing mode (all, rules, or none). |
district_licensing_enabled | Boolean | No | Whether the district manages product licensing rules. |
rate_limit_enabled | Boolean | No | Enable custom API rate limiting. |
rate_limit | Number | No | Maximum requests per second limit. |
Sample Request
const response = await axios.patch(
`https://ed.link/api/v2/teams/${team_id}/integrations/${integration_id}`,
{
district_licensing_enabled: true,
developer_sharing: 'rules'
},
{
headers: {
authorization: `Bearer ${user_session_token}`,
'content-type': 'application/json'
}
}
);
Sample Response
{
"$data": {
"id": "fd8e2612-1329-4d85-bb56-95dcb27d7c92",
"district_licensing_enabled": true,
"developer_sharing": "rules",
"updated_date": "2024-06-21T11:00:00.000Z"
}
}