Disconnect Integration API
The Disconnect Integration API lets a developer disconnect a platform integration by sending a DELETE request for a specific integration. Use this page as a contract sheet for the exact method, path, authorization header, required path parameter, and documented JSON responses, so an implementation can match the specified behavior without guessing field names or status codes.
Disconnect Integration API
Disconnect a platform integration by calling DELETE /v1/connect/integrations/{id}. The request has no documented request body in the source contract. The only documented path parameter is id, and the only documented authorization header is x-access-key. Before sending the request, confirm that the value you place in the path is the Integration ID you intend to disconnect, because the endpoint identifies the integration solely through that path segment. The origin-modular request example shows the full request shape with the placeholder origin and the unchanged path.
Authorization
Authorization uses the accessKey in the x-access-key header, with the value shown as <token> in the source contract. Send the header on the DELETE request exactly as named: x-access-key. The source does not specify a token format beyond that placeholder, so do not add alternative header names or assume a different credential scheme when implementing against this contract. If the header is missing or incorrect, the source contract does not document a specific response for that case, so handle authentication failures separately from the documented 200 and 404 responses rather than treating them as part of this endpoint contract.
Path Parameters
The path parameter table lists id as a required string described as Integration ID. Replace {id} in /v1/connect/integrations/{id} with that value for each call. The source does not document a format, pattern, or validation rule for the Integration ID, so preserve the value as a string and do not invent constraints such as a UUID format or numeric range. A practical failure check is to verify that the final URL contains a non-empty id segment before sending the request; an empty segment would not match the documented path shape.
Response Body
The documented responses use JSON. A 200 response returns an object with success and message, while a 404 response returns an object with error. Implement response handling by first checking the HTTP status, then reading only the fields documented for that status. Do not expect success or message on a 404, and do not expect error on a 200. The response examples show the exact field names and types to preserve in client code and tests.
200 application/json
For 200 application/json, success is a required boolean and message is a required string. In the documented example, success is true and message is a string placeholder. Treat success as the machine-readable outcome field and message as the accompanying human-readable string. When writing a client, assert both fields are present and that success is boolean and message is string before treating the disconnection as confirmed by the response body.
404 application/json
For 404 application/json, error is a required string. The source documents the status and field but does not explain the specific conditions that produce a 404, so do not invent a cause such as a deleted integration, a wrong profile, or a missing account. Handle this branch by surfacing the error string to the caller and by not retrying blindly as if the documented contract defined idempotency or retry behavior. If your workflow needs to distinguish why a 404 occurred, that distinction is not supplied by this contract and must be resolved separately.
Origin-modular request example
To implement the call, set the method to DELETE, build the URL from the placeholder origin plus /v1/connect/integrations/{id}, add the x-access-key header with the token value, and send the request without a documented body. After the call, branch on status: parse success and message for 200 application/json, and parse error for 404 application/json. Keep the method, path, header name, parameter name, and response field names exact, because changing any of them would create a different contract from the one documented here.
| Name | Required | Type | Description |
|---|---|---|---|
| id | Yes | string | Integration ID |
Exact source contract; no format or validation rule supplied for id.
| Status | Content type | Field | Required | Type |
|---|---|---|---|---|
| 200 | application/json | success | Yes | boolean |
| 200 | application/json | message | Yes | string |
| 404 | application/json | error | Yes | string |
Exact source contract; 404 conditions are not specified in the source.
curl -X DELETE "{{API_BASE_URL}}/v1/connect/integrations/{id}" \
-H "x-access-key: <token>"{
"success": true,
"message": "string"
}{
"error": "string"
}| Scope | Field | Type | Type reference | Required | Description |
|---|---|---|---|---|---|
| id#1 | id | string | __0 | Yes | Integration ID |
| response#2 | response | object | __0 | ||
| response#2 | response.success | boolean | __1 | Yes | |
| response#2 | response.message | string | __2 | Yes | |
| response#3 | response | object | __0 | ||
| response#3 | response.error | string | __1 | Yes |