API reference

PATCHSet your reference and metadata for a connected organization

PATCH /v1/partner/grants/{grant_id}: external_reference (e.g.

PATCHhttps://api.light-ai.app/v1/partner/grants/{grant_id}

external_reference (e.g. a HighLevel locationId) is echoed in every event of that organization, for routing.

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

Path parameters#

grant_idstringrequired#

The grant id (grant_…). Id prefix grant_.

Headers#

Light-AI-Versionstring#

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

Idempotency-Keystring#

Retry-safe writes: the same key and body replay the first response for 24 hours (Idempotent-Replayed: true). 8–128 characters.

Request body#

external_referencestring | null#

Your id for this contractor (e.g. a HighLevel locationId). null or "" clears it. 1–255 characters.

metadataobject | null#

Replaces the metadata; null is absent (send {} to empty it).

Response 200#

The grant.

idstringrequired#

Id prefix grant_.

objectstringrequired#

Always grant.

statusstringrequired#

One of: pending, active, superseded, revoked, suspended, expired.

versionintegerrequired#

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.

external_referencestring | nullrequired#

metadataobjectrequired#

client_labelstring | nullrequired#

granted_attimestamprequired#

RFC 3339 timestamp (UTC, milliseconds).

confirmed_attimestamp | nullrequired#

RFC 3339 timestamp (UTC, milliseconds).

pending_expires_attimestamp | nullrequired#

RFC 3339 timestamp (UTC, milliseconds).

revoked_attimestamp | nullrequired#

RFC 3339 timestamp (UTC, milliseconds).

organizationobject | nullrequired#

organization.idstringrequired#

Id prefix org_.

organization.namestring | nullrequired#

partnernull#

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 PATCH "https://api.light-ai.app/v1/partner/grants/{grant_id}" \
  -H "Authorization: Bearer $LIGHT_AI_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "external_reference": "ghl-location-AbC123",
  "metadata": {
    "region": "TX"
  }
}'

const response = await fetch('https://api.light-ai.app/v1/partner/grants/{grant_id}', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.LIGHT_AI_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "external_reference": "ghl-location-AbC123",
    "metadata": {
      "region": "TX"
    }
  }),
});
const data = await response.json();

import os, uuid, requests

response = requests.patch(
    "https://api.light-ai.app/v1/partner/grants/{grant_id}",
    headers={
        "Authorization": f"Bearer {os.environ['LIGHT_AI_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
      "external_reference": "ghl-location-AbC123",
      "metadata": {
        "region": "TX"
      }
    },
    timeout=30,
)
data = response.json()

Response 200JSON

{
  "id": "grant_3f9c2a7be41d…",
  "object": "grant",
  "status": "pending",
  "version": 0,
  "scopes": [
    "leads:read"
  ],
  "external_reference": "string",
  "metadata": {},
  "client_label": "string",
  "granted_at": "2026-10-12T14:03:11.000Z",
  "confirmed_at": "2026-10-12T14:03:11.000Z",
  "pending_expires_at": "2026-10-12T14:03:11.000Z",
  "revoked_at": "2026-10-12T14:03:11.000Z",
  "organization": {
    "id": "org_3f9c2a7be41d…",
    "name": "Dana Reyes"
  },
  "partner": null
}