API reference

PUTSet your id for a lead

PUT /v1/leads/{object_id}/external_refs/{system}: Writes back your CRM id.

PUThttps://api.light-ai.app/v1/leads/{object_id}/external_refs/{system}

Writes back your CRM id. References are namespaced by integration: you can never overwrite another integration's ids.

Scope	`leads:write`
Credential	API key: `Authorization: Bearer lai_live_…` (or `lai_test_…`). Partner keys add `Light-AI-Organization`.
Test mode	Works with test keys against simulated test objects.

Path parameters#

object_idstringrequired#

The lead id, or the receipt id (rcpt_…) of your own credential's request.

systemstringrequired#

Lowercase system name, e.g. jobber.

Headers#

Light-AI-Organizationstring#

Partner keys: the connected organization to act for (org_…). Organization keys may omit it. Id prefix org_.

Light-AI-Versionstring#

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

Request body#

idstringrequired#

The object's id in that system. 1–255 characters.

namespacestring | null#

Optional sub-namespace in that system. null or "": none. At most 120 characters.

Response 200#

The object's external references.

objectstringrequired#

Always external_refs.

dataobject[]required#

data[].systemstringrequired#

data[].namespacestring | nullrequired#

data[].idstringrequired#

data[].ownerstringrequired#

self: written by your integration (editable); others are read-only. One of: self, organization, partner.

data[].read_onlybooleanrequired#

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 PUT "https://api.light-ai.app/v1/leads/{object_id}/external_refs/{system}" \
  -H "Authorization: Bearer $LIGHT_AI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "Z2lkOi8vSm9iYmVy"
}'

const response = await fetch('https://api.light-ai.app/v1/leads/{object_id}/external_refs/{system}', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.LIGHT_AI_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "id": "Z2lkOi8vSm9iYmVy"
  }),
});
const data = await response.json();

import os, uuid, requests

response = requests.put(
    "https://api.light-ai.app/v1/leads/{object_id}/external_refs/{system}",
    headers={
        "Authorization": f"Bearer {os.environ['LIGHT_AI_API_KEY']}",
    },
    json={
      "id": "Z2lkOi8vSm9iYmVy"
    },
    timeout=30,
)
data = response.json()

Response 200JSON

{
  "object": "external_refs",
  "data": [
    {
      "system": "string",
      "namespace": "string",
      "id": "string",
      "owner": "self",
      "read_only": true
    }
  ]
}