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

Record Partner Checkout

Partner · REST API reference

Get support
PUT/v1/partner/checkouts/{checkout_ref}
Report a checkout's progress after its contact step and each later one, under your own checkout_ref. If the renter stops, the facility follows them up; name the checkout_ref when you send the lead to complete it. The answer is the same whatever became of the checkout.

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 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"
  }
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

checkout_refpath · stringrequired

Min length: 1 · Max length: 100

Request body

application/json · Required

attributionLeadAttribution | null
Show attribution schema
LeadAttribution | null
Variant 1: LeadAttribution
landing_pathstring | null

Path only.

Max length: 1024

Show landing_path schema
string | null

Path only.

Variant 1: string
string
Variant 2: null
null
referrer_hoststring | null

Host only.

Max length: 255

Show referrer_host schema
string | null

Host only.

Variant 1: string
string
Variant 2: null
null
utm_campaignstring | null

Max length: 255

Show utm_campaign schema
string | null
Variant 1: string
string
Variant 2: null
null
utm_contentstring | null

Max length: 255

Show utm_content schema
string | null
Variant 1: string
string
Variant 2: null
null
utm_mediumstring | null

Max length: 255

Show utm_medium schema
string | null
Variant 1: string
string
Variant 2: null
null
utm_sourcestring | null

Max length: 255

Show utm_source schema
string | null
Variant 1: string
string
Variant 2: null
null
utm_termstring | null

Max length: 255

Show utm_term schema
string | null
Variant 1: string
string
Variant 2: null
null
visitor_idstring | null

The site's per-tab visitor id.

Max length: 64

Show visitor_id schema
string | null

The site's per-tab visitor id.

Variant 1: string
string
Variant 2: null
null
Variant 2: null
null
contactPartnerCheckoutContactRequest

What the renter has typed so far: every field optional until the checkout's contact step.

Show contact schema
emailstring | null

Max length: 255

Show email schema
string | null
Variant 1: string
string
Variant 2: null
null
first_namestring | null

Max length: 100

Show first_name schema
string | null
Variant 1: string
string
Variant 2: null
null
last_namestring | null

Max length: 100

Show last_name schema
string | null
Variant 1: string
string
Variant 2: null
null
phonestring | null

Max length: 40

Show phone schema
string | null
Variant 1: string
string
Variant 2: null
null
facility_idstringrequired

Format: uuid

interestPartnerCheckoutInterestRequest
Show interest schema
desired_move_in_datestring | null

Format: date

Show desired_move_in_date schema
string | null
Variant 1: string
string
Variant 2: null
null
unit_group_idstring | null

Format: uuid

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

Format: uuid

Show unit_id schema
string | null
Variant 1: string
string
Variant 2: null
null
sms_consentPartnerConsentRequest | null

Needs a phone.

Show sms_consent schema
PartnerConsentRequest | null

Needs a phone.

Variant 1: PartnerConsentRequest
captured_atstringrequired

Format: date-time

disclosure_textstringrequired

Min length: 1 · Max length: 2000

ip_addressstring | null

Max length: 45

Show ip_address schema
string | null
Variant 1: string
string
Variant 2: null
null
page_urlstringrequired

Min length: 1 · Max length: 2048

Variant 2: null
null

Responses

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

202Successful Response
JSON · generated example
{
  "data": {
    "checkout_ref": "string"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataPartnerCheckoutResponserequired
Show data schema
checkout_refstringrequired
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

Record Partner Checkout | Facily Developers