Update status, display name, sidebar, settings, action permissions (requires write scope)
PATCH
/projects/{projectId}/integrations/{provider}/lifecycle
Authentication
API Key (header: X-API-Key)
Path Parameters
projectId
string
required
path
provider
string
required
path
Request Body
application/jsonstatus
string
Enum:
active, paused, disconnecteddisplay_name
string
sidebar_enabled
boolean
settings
object
action_permissions
object
Responses
200
Updated
application/jsondata
object
An installed third-party integration
id
string
provider
string
e.g. slack, github, shopify, stripe, linear, discord
status
string
Enum:
active, paused, disconnected, errordisplay_name
string | null
setup_type
string
health_status
string
sidebar_enabled
boolean
last_synced_at
string (date-time) | null
error_message
string | null
created_at
string (date-time)
updated_at
string (date-time)
curl -X PATCH 'https://api.rogeriq.com/api/v1/projects/string/integrations/string/lifecycle' \ -H 'Authorization: Bearer YOUR_API_TOKEN' \ -H 'Content-Type: application/json' \ -d '{ "status": "active", "display_name": "string", "sidebar_enabled": true, "settings": {}, "action_permissions": {}}'
const response = await fetch('https://api.rogeriq.com/api/v1/projects/string/integrations/string/lifecycle', { method: 'PATCH', headers: { "Authorization": "Bearer YOUR_API_TOKEN", "Content-Type": "application/json" }, body: JSON.stringify({ "status": "active", "display_name": "string", "sidebar_enabled": true, "settings": {}, "action_permissions": {} })});const data = await response.json();console.log(data);
import requestsheaders = { 'Authorization': 'Bearer YOUR_API_TOKEN'}response = requests.patch('https://api.rogeriq.com/api/v1/projects/string/integrations/string/lifecycle', headers=headers, json={ "status": "active", "display_name": "string", "sidebar_enabled": true, "settings": {}, "action_permissions": {}})print(response.json())
200
Response
{ "data": { "id": "<string>", "provider": "<string>", "status": "active", "display_name": "<string>", "setup_type": "<string>", "health_status": "<string>", "sidebar_enabled": true, "last_synced_at": "2024-01-01T00:00:00Z", "error_message": "<string>", "created_at": "2024-01-01T00:00:00Z", "updated_at": "2024-01-01T00:00:00Z" }}
API Playground
Try this endpoint
PATCH
/projects/{projectId}/integrations/{provider}/lifecycle