/v1/tenants/{tenant_id}/do-not-rentAuthentication
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 DELETE \
--url 'https://api.staging.facily.ai/v1/tenants/<TENANT_ID>/do-not-rent' \
--header "Authorization: Bearer $FACILY_API_KEY"Parameters
tenant_idpath · stringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"do_not_rent_at": "2026-10-29T12:00:00Z",
"do_not_rent_by": "00000000-0000-4000-8000-000000000001",
"do_not_rent_note": "string",
"do_not_rent_reason": "delinquency",
"tenant_id": "00000000-0000-4000-8000-000000000001"
},
"meta": {
"request_id": "string"
}
}application/json
dataTenantDoNotRentResponserequiredThe tenant's do-not-rent flag after the change; every field but the id is null once the flag is cleared.
Show data schema
do_not_rent_atstring | nullrequiredWhen staff first flagged this person as do not rent; null when not flagged.
Format: date-time
Show do_not_rent_at schema
string | nullWhen staff first flagged this person as do not rent; null when not flagged.
Variant 1: string
stringVariant 2: null
nulldo_not_rent_bystring | nullrequiredThe staff user who first flagged this person.
Format: uuid
Show do_not_rent_by schema
string | nullThe staff user who first flagged this person.
Variant 1: string
stringVariant 2: null
nulldo_not_rent_notestring | nullrequiredThe staff note that goes with the flag.
Show do_not_rent_note schema
string | nullThe staff note that goes with the flag.
Variant 1: string
stringVariant 2: null
nulldo_not_rent_reasonstring | nullrequiredWhy staff should not rent to this person: delinquency, fraud, damage, conduct or other.
Values: "delinquency", "fraud", "damage", "conduct", "other"
Show do_not_rent_reason schema
string | nullWhy staff should not rent to this person: delinquency, fraud, damage, conduct or other.
Variant 1: string
stringValues: "delinquency", "fraud", "damage", "conduct", "other"
Variant 2: null
nulltenant_idstringrequiredThe tenant the flag belongs to.
Format: uuid
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