Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsUpdate Lead Channel
Search the full API reference Esc to close

Update Lead Channel

Leads · REST API reference

Get support
PATCH/v1/lead-channels/{channel_id}
Edit a lead channel; `active: false` retires it.

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request PATCH \
  --url 'https://api.staging.facily.ai/v1/lead-channels/<CHANNEL_ID>' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "active": false,
  "analytics_site_id": "<VALUE_MATCHING_PATTERN>",
  "facility_ids": [
    "00000000-0000-4000-8000-000000000001"
  ],
  "kind": "website",
  "name": "string",
  "rate_basis": "street",
  "send_confirmation": false
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

channel_idpath · stringrequired

Format: uuid

Request body

application/json · Required

activeboolean | null

false retires the channel.

Show active schema
boolean | null

false retires the channel.

Variant 1: boolean
boolean
Variant 2: null
null
analytics_site_idstring | null

The channel's website id (a UUID) in Facily's website analytics; null for none.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Show analytics_site_id schema
string | null

The channel's website id (a UUID) in Facily's website analytics; null for none.

Variant 1: string
string
Variant 2: null
null
facility_idsstring[] | null

The new facility set; [] for every facility. Needs the configure permission on every one. It also changes what the channel's partner keys reach.

Show facility_ids schema
string[] | null

The new facility set; [] for every facility. Needs the configure permission on every one. It also changes what the channel's partner keys reach.

Variant 1: string[]
string[]
Variant 2: null
null
kindstring | null

website, marketplace, call_center, kiosk or other. Refused (409 channel_has_keys) while a partner key uses the channel.

Values: "website", "marketplace", "call_center", "kiosk", "other"

Show kind schema
string | null

website, marketplace, call_center, kiosk or other. Refused (409 channel_has_keys) while a partner key uses the channel.

Variant 1: string
string

Values: "website", "marketplace", "call_center", "kiosk", "other"

Variant 2: null
null
namestring | null

The new name.

Min length: 1 · Max length: 100

Show name schema
string | null

The new name.

Variant 1: string
string
Variant 2: null
null
rate_basisstring | null

The rate the channel's partners are shown and hold at: web or street.

Values: "street", "web"

Show rate_basis schema
string | null

The rate the channel's partners are shown and hold at: web or street.

Variant 1: string
string

Values: "street", "web"

Variant 2: null
null
send_confirmationboolean | null

false: Facily sends no reservation or inquiry confirmation to the channel's renters (it sends its own).

Show send_confirmation schema
boolean | null

false: Facily sends no reservation or inquiry confirmation to the channel's renters (it sends its own).

Variant 1: boolean
boolean
Variant 2: null
null

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "data": {
    "active": false,
    "analytics_site_id": "string",
    "created_at": "2026-10-29T12:00:00Z",
    "facility_ids": [
      "00000000-0000-4000-8000-000000000001"
    ],
    "id": "00000000-0000-4000-8000-000000000001",
    "kind": "string",
    "name": "string",
    "partner_key_count": 0,
    "rate_basis": "string",
    "send_confirmation": false,
    "updated_at": "2026-10-29T12:00:00Z"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataLeadChannelResponserequired
Show data schema
activebooleanrequired

false when the channel is retired.

analytics_site_idstring | nullrequired

The channel's website id (a UUID) in Facily's website analytics; null for none.

Show analytics_site_id schema
string | null

The channel's website id (a UUID) in Facily's website analytics; null for none.

Variant 1: string
string
Variant 2: null
null
created_atstringrequired

When the channel was created.

Format: date-time

facility_idsstring[]required

Facilities the entry applies at; [] means every facility.

Show facility_ids schema
string
idstringrequired

Unique identifier for this channel.

Format: uuid

kindstringrequired

website, marketplace, call_center, kiosk or other.

namestringrequired

The channel's name.

partner_key_countintegerrequired

Unrevoked partner keys bound to the channel, expired ones included (an edit can renew one).

rate_basisstringrequired

The rate the channel's partners are shown and hold at: web or street.

send_confirmationbooleanrequired

false: Facily sends no reservation or inquiry confirmation to the channel's renters (it sends its own).

updated_atstringrequired

When the channel was last modified.

Format: date-time

metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll leads operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Update Lead Channel | Facily Developers