/v1/partner/checkouts/{checkout_ref}Authentication
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 PUT \
--url 'https://api.staging.facily.ai/v1/partner/checkouts/<CHECKOUT_REF>' \
--header "Authorization: Bearer $FACILY_PARTNER_KEY" \
--header 'Content-Type: application/json' \
--data '{
"facility_id": "00000000-0000-4000-8000-000000000001",
"attribution": {
"landing_path": "string",
"referrer_host": "string",
"utm_campaign": "string",
"utm_content": "string",
"utm_medium": "string",
"utm_source": "string",
"utm_term": "string",
"visitor_id": "string"
},
"contact": {
"email": "string",
"first_name": "string",
"last_name": "string",
"phone": "string"
},
"interest": {
"desired_move_in_date": "2026-10-29",
"unit_group_id": "00000000-0000-4000-8000-000000000001",
"unit_id": "00000000-0000-4000-8000-000000000001"
},
"sms_consent": {
"captured_at": "2026-10-29T12:00:00Z",
"disclosure_text": "string",
"page_url": "string",
"ip_address": "string"
}
}'Parameters
checkout_refpath · stringrequiredMin length: 1 · Max length: 100
Request body
application/json · Required
attributionLeadAttribution | nullShow attribution schema
LeadAttribution | nullVariant 1: LeadAttribution
landing_pathstring | nullPath only.
Max length: 1024
Show landing_path schema
string | nullPath only.
Variant 1: string
stringVariant 2: null
nullreferrer_hoststring | nullHost only.
Max length: 255
Show referrer_host schema
string | nullHost only.
Variant 1: string
stringVariant 2: null
nullutm_campaignstring | nullMax length: 255
Show utm_campaign schema
string | nullVariant 1: string
stringVariant 2: null
nullutm_contentstring | nullMax length: 255
Show utm_content schema
string | nullVariant 1: string
stringVariant 2: null
nullutm_mediumstring | nullMax length: 255
Show utm_medium schema
string | nullVariant 1: string
stringVariant 2: null
nullutm_sourcestring | nullMax length: 255
Show utm_source schema
string | nullVariant 1: string
stringVariant 2: null
nullutm_termstring | nullMax length: 255
Show utm_term schema
string | nullVariant 1: string
stringVariant 2: null
nullvisitor_idstring | nullThe site's per-tab visitor id.
Max length: 64
Show visitor_id schema
string | nullThe site's per-tab visitor id.
Variant 1: string
stringVariant 2: null
nullVariant 2: null
nullcontactPartnerCheckoutContactRequestWhat the renter has typed so far: every field optional until the checkout's contact step.
Show contact schema
emailstring | nullMax length: 255
Show email schema
string | nullVariant 1: string
stringVariant 2: null
nullfirst_namestring | nullMax length: 100
Show first_name schema
string | nullVariant 1: string
stringVariant 2: null
nulllast_namestring | nullMax length: 100
Show last_name schema
string | nullVariant 1: string
stringVariant 2: null
nullphonestring | nullMax length: 40
Show phone schema
string | nullVariant 1: string
stringVariant 2: null
nullfacility_idstringrequiredFormat: uuid
interestPartnerCheckoutInterestRequestShow interest schema
desired_move_in_datestring | nullFormat: date
Show desired_move_in_date schema
string | nullVariant 1: string
stringVariant 2: null
nullunit_group_idstring | nullFormat: uuid
Show unit_group_id schema
string | nullVariant 1: string
stringVariant 2: null
nullunit_idstring | nullFormat: uuid
Show unit_id schema
string | nullVariant 1: string
stringVariant 2: null
nullsms_consentPartnerConsentRequest | nullNeeds a phone.
Show sms_consent schema
PartnerConsentRequest | nullNeeds a phone.
Variant 1: PartnerConsentRequest
captured_atstringrequiredFormat: date-time
disclosure_textstringrequiredMin length: 1 · Max length: 2000
ip_addressstring | nullMax length: 45
Show ip_address schema
string | nullVariant 1: string
stringVariant 2: null
nullpage_urlstringrequiredMin length: 1 · Max length: 2048
Variant 2: null
nullResponses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
202Successful Response
{
"data": {
"checkout_ref": "string"
},
"meta": {
"request_id": "string"
}
}application/json
dataPartnerCheckoutResponserequiredShow data schema
checkout_refstringrequiredmetaMetarequiredEnvelope 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