/v1/lead-channels/{channel_id}Authentication
Bearer API key or Facily session, subject to permissions and facility scope.
Authentication and scopeRequest 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 --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
}'Parameters
channel_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
activeboolean | nullfalse retires the channel.
Show active schema
boolean | nullfalse retires the channel.
Variant 1: boolean
booleanVariant 2: null
nullanalytics_site_idstring | nullThe 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 | nullThe channel's website id (a UUID) in Facily's website analytics; null for none.
Variant 1: string
stringVariant 2: null
nullfacility_idsstring[] | nullThe 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[] | nullThe 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
nullkindstring | nullwebsite, 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 | nullwebsite, marketplace, call_center, kiosk or other. Refused (409 channel_has_keys) while a partner key uses the channel.
Variant 1: string
stringValues: "website", "marketplace", "call_center", "kiosk", "other"
Variant 2: null
nullnamestring | nullThe new name.
Min length: 1 · Max length: 100
Show name schema
string | nullThe new name.
Variant 1: string
stringVariant 2: null
nullrate_basisstring | nullThe rate the channel's partners are shown and hold at: web or street.
Values: "street", "web"
Show rate_basis schema
string | nullThe rate the channel's partners are shown and hold at: web or street.
Variant 1: string
stringValues: "street", "web"
Variant 2: null
nullsend_confirmationboolean | nullfalse: Facily sends no reservation or inquiry confirmation to the channel's renters (it sends its own).
Show send_confirmation schema
boolean | nullfalse: Facily sends no reservation or inquiry confirmation to the channel's renters (it sends its own).
Variant 1: boolean
booleanVariant 2: null
nullResponses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"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
dataLeadChannelResponserequiredShow data schema
activebooleanrequiredfalse when the channel is retired.
analytics_site_idstring | nullrequiredThe channel's website id (a UUID) in Facily's website analytics; null for none.
Show analytics_site_id schema
string | nullThe channel's website id (a UUID) in Facily's website analytics; null for none.
Variant 1: string
stringVariant 2: null
nullcreated_atstringrequiredWhen the channel was created.
Format: date-time
facility_idsstring[]requiredFacilities the entry applies at; [] means every facility.
Show facility_ids schema
stringidstringrequiredUnique identifier for this channel.
Format: uuid
kindstringrequiredwebsite, marketplace, call_center, kiosk or other.
namestringrequiredThe channel's name.
partner_key_countintegerrequiredUnrevoked partner keys bound to the channel, expired ones included (an edit can renew one).
rate_basisstringrequiredThe rate the channel's partners are shown and hold at: web or street.
send_confirmationbooleanrequiredfalse: Facily sends no reservation or inquiry confirmation to the channel's renters (it sends its own).
updated_atstringrequiredWhen the channel was last modified.
Format: date-time
metaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired400Validation error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired401Unauthenticated
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired403Permission denied
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired404Not found
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired409Business logic error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired503Temporary failure
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired