Update Integration
Update an existing integration's properties
Updates the properties of an existing integration. Only provide the fields you want to change.
Base URL
https://api.ajan.io/integrations/v1/{integrationId}Required Scopes
This endpoint requires the INTEGRATION_API scope.
Parameters
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
integrationId | string | Yes | UUID of the integration |
Request Body
All fields are optional. Only include fields you want to update.
| Parameter | Type | Description |
|---|---|---|
name | string | Integration name (max 40 characters) |
description | string | Integration description (max 90 characters) |
iconUrl | string | URL to the integration icon |
color | string | Hex color code for the integration |
Example
javascript
const axios = require("axios");
async function updateIntegration(integrationId) {
const response = await axios.patch(
`https://api.ajan.io/integrations/v1/${integrationId}`,
{
name: "Updated Integration Name",
description: "New description for the integration"
},
{
headers: {
Authorization: "Bearer YOUR_API_KEY",
"Content-Type": "application/json"
}
}
);
console.log("Updated integration:", response.data.integration);
}
updateIntegration("550e8400-e29b-41d4-a716-446655440000");Response Format
Success Response (200 OK)
typescript
{
integration: {
id: string;
name: string;
description: string;
};
}Error Handling
| Status Code | Description |
|---|---|
| 400 | Invalid request body or integration ID |
| 401 | Invalid or missing API key |
| 403 | No access to this integration |
| 404 | Integration not found |
| 429 | Rate limit exceeded |