API reference

POSTRevoke an unused connect link

POST /v1/partner/connect_links/{connect_link_id}/revoke: Revoke an unused connect link

POSThttps://api.light-ai.app/v1/partner/connect_links/{connect_link_id}/revoke

Credential	Partner API key (a key of a partner account).
Test mode	Live keys only (answers 400 `test_mode_unsupported` to a test key).

Path parameters#

connect_link_idstringrequired#

The link id (cl_…). Id prefix cl_.

Headers#

Light-AI-Versionstring#

Pin a dated API version (defaults to the key's version). One of: 2026-11-01.

Request body#

An empty JSON object ({}) or no body.

Response 200#

The revoked link.

idstringrequired#

Id prefix cl_.

objectstringrequired#

Always connect_link.

scopesstring[]required#

One of: leads:read, leads:write, clients:read, clients:write, projects:read, projects:write, quotes:read, quotes:write, quotes:share_link, quotes:asset_links, webhooks:manage, events:read, mockups:read, mockups:write, forms:read, forms:write.

bound_organizationstring | nullrequired#

Id prefix org_.

client_labelstring | nullrequired#

external_referencestring | nullrequired#

metadataobjectrequired#

redirect_uristring | nullrequired#

statusstringrequired#

One of: open, consumed, expired, revoked.

grantstring | nullrequired#

Id prefix grant_.

created_attimestamprequired#

RFC 3339 timestamp (UTC, milliseconds).

expires_attimestamprequired#

RFC 3339 timestamp (UTC, milliseconds).

consumed_attimestamp | nullrequired#

RFC 3339 timestamp (UTC, milliseconds).

urlstring#

The link to send to the contractor. Returned only when created.

Errors#

Status	Meaning
`400`	Bad request. `bad_request`, `test_mode_mismatch`, `test_mode_unsupported`, `unsupported_api_version`
`401`	Missing or invalid credential. `authentication_required`, `invalid_api_key`, `api_key_revoked`, `api_key_expired`, `api_key_suspended`
`403`	Not allowed. `insufficient_scope`, `plan_upgrade_required`, `organization_paused`, `organization_off_season`, `api_disabled`, `api_access_not_enabled`, `ip_not_allowed`, `forbidden`
`404`	Not found (also for objects of other organizations and for organizations without an active grant).
`409`	Conflict. `stale_state`, `conflict`, `idempotency_in_progress`, `idempotency_scope_mismatch`, `quote_already_decided`, `quote_not_current`, `billing_review_required`
`413`	Request bodies are limited to 256 KB.
`415`	The body is not JSON: send Content-Type: application/json. `unsupported_media_type`
`422`	Validation failed. `idempotency_key_reused`
`429`	Rate limited or daily cap reached. See Retry-After and the RateLimit headers. `rate_limited`, `daily_cap_reached`
`500`	Unexpected server error. Safe to retry with exponential backoff; quote the Request-Id to support. `internal_error`
`503`	Temporarily unavailable. Retry with exponential backoff. `service_unavailable`

Request

curl -X POST "https://api.light-ai.app/v1/partner/connect_links/{connect_link_id}/revoke" \
  -H "Authorization: Bearer $LIGHT_AI_API_KEY"

const response = await fetch('https://api.light-ai.app/v1/partner/connect_links/{connect_link_id}/revoke', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LIGHT_AI_API_KEY}`,
  },
});
const data = await response.json();

import os, uuid, requests

response = requests.post(
    "https://api.light-ai.app/v1/partner/connect_links/{connect_link_id}/revoke",
    headers={
        "Authorization": f"Bearer {os.environ['LIGHT_AI_API_KEY']}",
    },
    timeout=30,
)
data = response.json()

Response 200JSON

{
  "id": "cl_3f9c2a7be41d…",
  "object": "connect_link",
  "scopes": [
    "leads:read"
  ],
  "bound_organization": "org_3f9c2a7be41d…",
  "client_label": "string",
  "external_reference": "string",
  "metadata": {},
  "redirect_uri": "string",
  "status": "open",
  "grant": "grant_3f9c2a7be41d…",
  "created_at": "2026-10-12T14:03:11.000Z",
  "expires_at": "2026-10-12T14:03:11.000Z",
  "consumed_at": "2026-10-12T14:03:11.000Z",
  "url": "https://example.com/…"
}