Delete a managed connection

DELETE/api/embed/v1/accounts/{accountId}/connections/{connectionKey}

Deletes a connection you manage. Refused while a live workflow uses it.

Needs a partner key: Authorization: Bearer gre_…, from Platform › Partner keys. Call it from your server only.

Embed · Self-hosted with an Embed license

Parameters

Path

accountIdRequired · string: Your ID for the customer’s account: 1 to 255 bytes of UTF-8, case-sensitive. URL-encode it: it may contain /.
connectionKeyRequired · string: Your key for the connection: 1 to 255 bytes, unique in its workspace. URL-encode it.

Query

workspaceIdOptional · string: The workspace, by your ID. Left out: the default workspace.

Request

GORUNNER="https://automations.example.com"
GORUNNER_EMBED_KEY="YOUR_PARTNER_KEY"  # gre_…
ACCOUNT_ID="acct-bakery"
CONNECTION_KEY="sheets-main"

URL="$GORUNNER/api/embed/v1/accounts/$ACCOUNT_ID/"
URL="${URL}connections/$CONNECTION_KEY"
curl -X DELETE "$URL" \
  -H "Authorization: Bearer $GORUNNER_EMBED_KEY"

const GORUNNER = "https://automations.example.com";
const KEY = process.env.GORUNNER_EMBED_KEY; // gre_…
const ACCOUNT_ID = encodeURIComponent("acct-bakery");
const CONNECTION_KEY = encodeURIComponent("sheets-main");

const res = await fetch(
  `${GORUNNER}/api/embed/v1/accounts/` +
    `${ACCOUNT_ID}/connections/${CONNECTION_KEY}`,
  {
    method: "DELETE",
    headers: { Authorization: `Bearer ${KEY}` },
  },
);
console.log(res.status); // 204

import os, requests
from urllib.parse import quote

GORUNNER = "https://automations.example.com"
KEY = os.environ["GORUNNER_EMBED_KEY"]  # gre_…
ACCOUNT_ID = quote("acct-bakery", safe="")
CONNECTION_KEY = quote("sheets-main", safe="")

res = requests.delete(
    f"{GORUNNER}/api/embed/v1/accounts/"
    f"{ACCOUNT_ID}/connections/{CONNECTION_KEY}",
    headers={"Authorization": f"Bearer {KEY}"},
)
print(res.status_code)  # 204

Response · 204 No Content

http

HTTP/1.1 204 No Content

Responses

204No Content
Deleted.
400VALIDATION_ERROR
A parameter isn’t valid. details.field names it.
404NOT_FOUND
No such account, workspace or connection key.
409CONFLICT
A live workflow still uses it: details.workflows lists them. Disable or change those first.
409ACCOUNT_DELETED
The account is deleted. Restore it first, within 30 days.
500INTERNAL_ERROR
Something failed on the installation’s side. Try again.

Any call can also answer: 401 UNAUTHORIZED · 403 EMBED_NOT_LICENSED · 403 IP_NOT_ALLOWED · 429 RATE_LIMITED · 503 BUSY. See Errors.

Response · 409 Conflict

json

{
  "error": {
    "code": "CONFLICT",
    "message": "…",
    "details": {
      "workflows": [
        "3b1e5c2a-7d4f-4e8b-a1c6-5f2d9b0e7a31"
      ]
    }
  }
}

Every field

It takes no body.

204 No Content: no body.

Delete a managed connection

Parameters

Path

Query

Responses

Panel