/v1/lead-close-reasons/{reason_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-close-reasons/<REASON_ID>' \
--header "Authorization: Bearer $FACILY_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"active": false,
"facility_ids": [
"00000000-0000-4000-8000-000000000001"
],
"reason": "string",
"sort_order": 0
}'Parameters
reason_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
activeboolean | nullfalse retires the reason; a reason the system uses cannot be.
Show active schema
boolean | nullfalse retires the reason; a reason the system uses cannot be.
Variant 1: boolean
booleanVariant 2: null
nullfacility_idsstring[] | nullThe new facility set; [] for every facility. Needs the configure permission on every one.
Show facility_ids schema
string[] | nullThe new facility set; [] for every facility. Needs the configure permission on every one.
Variant 1: string[]
string[]Variant 2: null
nullreasonstring | nullThe new wording.
Min length: 1 · Max length: 100
Show reason schema
string | nullThe new wording.
Variant 1: string
stringVariant 2: null
nullsort_orderinteger | nullPosition in lists, lowest first.
Minimum: 0
Show sort_order schema
integer | nullPosition in lists, lowest first.
Variant 1: integer
integerVariant 2: null
nullResponses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"active": false,
"created_at": "2026-10-29T12:00:00Z",
"facility_ids": [
"00000000-0000-4000-8000-000000000001"
],
"id": "00000000-0000-4000-8000-000000000001",
"reason": "string",
"sort_order": 0,
"system_key": "string",
"updated_at": "2026-10-29T12:00:00Z"
},
"meta": {
"request_id": "string"
}
}application/json
dataLeadCloseReasonResponserequiredShow data schema
activebooleanrequiredfalse when the reason is retired.
created_atstringrequiredWhen the reason was created.
Format: date-time
facility_idsstring[]requiredFacilities the entry applies at; [] means every facility.
Show facility_ids schema
stringidstringrequiredUnique identifier for this close reason.
Format: uuid
reasonstringrequiredShown when a lead is closed.
sort_orderintegerrequiredPosition in lists, lowest first.
system_keystring | nullrequiredSet on a reason the system itself uses, such as reservation_expired; such a reason cannot be retired.
Show system_key schema
string | nullSet on a reason the system itself uses, such as reservation_expired; such a reason cannot be retired.
Variant 1: string
stringVariant 2: null
nullupdated_atstringrequiredWhen the reason 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