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

Cancel Partner Lead

Partner · REST API reference

Get support
POST/v1/partner/leads/{lead_id}/cancel
The renter cancelled on your site: closes the lead as Cancelled online and frees any unit it held. A lead that is already closed is refused.

Authentication

Channel-scoped partner key.

A standard staff key is not interchangeable with a partner key. Call this endpoint from your server.

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/partner/leads/<LEAD_ID>/cancel' \
  --header "Authorization: Bearer $FACILY_PARTNER_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

lead_idpath · stringrequired

Format: uuid

Responses

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

200Successful Response
JSON · generated example
{
  "data": {
    "closed_at": "2026-10-29T12:00:00Z",
    "created": false,
    "facility_id": "00000000-0000-4000-8000-000000000001",
    "id": "00000000-0000-4000-8000-000000000001",
    "lead_number": "string",
    "reservation": {
      "expires_at": "2026-10-29T12:00:00Z",
      "promotion_id": "00000000-0000-4000-8000-000000000001",
      "quoted_rate": "<VALUE_MATCHING_PATTERN>",
      "rate_basis": "string",
      "reserved_at": "2026-10-29T12:00:00Z",
      "unit_group_id": "00000000-0000-4000-8000-000000000001",
      "unit_id": "00000000-0000-4000-8000-000000000001",
      "unit_number": "string"
    },
    "status": "string",
    "wait_list_unit_group_id": "00000000-0000-4000-8000-000000000001"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataPartnerLeadResponserequired
Show data schema
closed_atstring | nullrequired

Format: date-time

Show closed_at schema
string | null
Variant 1: string
string
Variant 2: null
null
createdbooleanrequired

True when this call created the lead; false for a repeat or a read.

facility_idstringrequired

Format: uuid

idstringrequired

Format: uuid

lead_numberstring | nullrequired

The confirmation number to show the renter.

Show lead_number schema
string | null

The confirmation number to show the renter.

Variant 1: string
string
Variant 2: null
null
reservationPartnerLeadReservationResponse | nullrequired
Show reservation schema
PartnerLeadReservationResponse | null
Variant 1: PartnerLeadReservationResponse
expires_atstring | nullrequired

When the hold lapses; null when it does not.

Format: date-time

Show expires_at schema
string | null

When the hold lapses; null when it does not.

Variant 1: string
Variant 2: null
promotion_idstring | nullrequired

Format: uuid

Show promotion_id schema
string | null
Variant 1: string
Variant 2: null
quoted_ratestringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

rate_basisstringrequired
reserved_atstringrequired

Format: date-time

unit_group_idstring | nullrequired

Format: uuid

Show unit_group_id schema
string | null
Variant 1: string
Variant 2: null
unit_idstringrequired

Format: uuid

unit_numberstringrequired
Variant 2: null
null
statusstringrequired

inquiry, reserved, moved_in or cancelled.

wait_list_unit_group_idstring | nullrequired

Format: uuid

Show wait_list_unit_group_id schema
string | null
Variant 1: string
string
Variant 2: null
null
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 partner operations
Build something that works beautifully.

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

Cancel Partner Lead | Facily Developers