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

Create Lead Channel

Leads · REST API reference

Get support
POST/v1/facilities/{facility_id}/lead-channels
Add a lead channel. Under `all`, `facility_ids` omitted or [] is every facility.

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 POST \
  --url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/lead-channels' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "kind": "website",
  "name": "string",
  "analytics_site_id": "<VALUE_MATCHING_PATTERN>",
  "facility_ids": [
    "00000000-0000-4000-8000-000000000001"
  ],
  "rate_basis": "web",
  "send_confirmation": true
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

facility_idpath · string | stringrequired

Format: uuid

Request body

application/json · Required

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

Facilities the entry applies at. Omit for the facility in the path; [] for every facility (Corporate, needs an organization-wide grant). A non-empty list must include the path facility. With `all` in the path, omitted or [] is every facility.

Show facility_ids schema
string[] | null

Facilities the entry applies at. Omit for the facility in the path; [] for every facility (Corporate, needs an organization-wide grant). A non-empty list must include the path facility. With `all` in the path, omitted or [] is every facility.

Variant 1: string[]
string[]
Variant 2: null
null
kindstringrequired

website, marketplace, call_center, kiosk or other.

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

namestringrequired

The channel's name.

Min length: 1 · Max length: 100

rate_basisstring

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

Default: "web" · Values: "street", "web"

send_confirmationboolean

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

Default: true

Responses

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

201Successful 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

Create Lead Channel | Facily Developers