/v1/partner/leads/{lead_id}/cancelAuthentication
Channel-scoped partner key.
A standard staff key is not interchangeable with a partner key. Call this endpoint from your server.
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 POST \
--url 'https://api.staging.facily.ai/v1/partner/leads/<LEAD_ID>/cancel' \
--header "Authorization: Bearer $FACILY_PARTNER_KEY"Parameters
lead_idpath · stringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"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
dataPartnerLeadResponserequiredShow data schema
closed_atstring | nullrequiredFormat: date-time
Show closed_at schema
string | nullVariant 1: string
stringVariant 2: null
nullcreatedbooleanrequiredTrue when this call created the lead; false for a repeat or a read.
facility_idstringrequiredFormat: uuid
idstringrequiredFormat: uuid
lead_numberstring | nullrequiredThe confirmation number to show the renter.
Show lead_number schema
string | nullThe confirmation number to show the renter.
Variant 1: string
stringVariant 2: null
nullreservationPartnerLeadReservationResponse | nullrequiredShow reservation schema
PartnerLeadReservationResponse | nullVariant 1: PartnerLeadReservationResponse
expires_atstring | nullrequiredWhen the hold lapses; null when it does not.
Format: date-time
Show expires_at schema
string | nullWhen the hold lapses; null when it does not.
Variant 1: string
Variant 2: null
promotion_idstring | nullrequiredFormat: uuid
Show promotion_id schema
string | nullVariant 1: string
Variant 2: null
quoted_ratestringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
rate_basisstringrequiredreserved_atstringrequiredFormat: date-time
unit_group_idstring | nullrequiredFormat: uuid
Show unit_group_id schema
string | nullVariant 1: string
Variant 2: null
unit_idstringrequiredFormat: uuid
unit_numberstringrequiredVariant 2: null
nullstatusstringrequiredinquiry, reserved, moved_in or cancelled.
wait_list_unit_group_idstring | nullrequiredFormat: uuid
Show wait_list_unit_group_id schema
string | nullVariant 1: string
stringVariant 2: null
nullmetaMetarequiredEnvelope 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