Integrations

PATCH /connections/{connectionId}

PATCH
/organizations/{organizationId}/connections/{connectionId}

Updates a connection's label, settings or capabilities, or turns it on or off.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Path Parameters

organizationId*string
connectionId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/organizations/string/connections/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "organizationId": "string",  "integrationKey": "string",  "label": "string",  "status": "pending",  "authStrategy": "oauth2",  "capabilitiesEnabled": [    "dsar_lookup"  ],  "config": {    "property1": null,    "property2": null  },  "permissionsHealth": {    "deniedActions": [      "string"    ],    "affectedAccounts": [      "string"    ],    "firstSeenAt": "string",    "lastSeenAt": "string"  },  "hasCredential": true,  "credentialVersion": 0,  "lastConnectedAt": "string",  "lastError": "string",  "createdByUserId": "string",  "dateCreated": null,  "dateUpdated": null,  "property1": null,  "property2": null}