Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsPreview Facility Launch
Search the full API reference Esc to close

Preview Facility Launch

Promotions · REST API reference

Get support
POST/v1/facilities/{facility_id}/promotion-launches/preview
The same preview while the promotion is still a wizard draft (plan Deviation 1).

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

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 POST \
  --url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/promotion-launches/preview' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "audiences": [
    "existing_tenants"
  ],
  "valid_from": "2026-10-29"
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

facility_idpath · stringrequired

Format: uuid

Request body

application/json · Required

audiencesstring[]

Max items: 4

Show audiences schema
string

Values: "existing_tenants", "recent_leads", "active_reservations", "abandoned_checkouts"

valid_fromstring | null

Format: date

Show valid_from schema
string | null
Variant 1: string
string
Variant 2: null
null

Responses

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

200Successful Response
JSON · generated example
{
  "data": {
    "audiences": [
      {
        "audience": "existing_tenants",
        "candidates": 0,
        "eligible_email": 0,
        "locked": false
      }
    ],
    "blocker_messages": [
      "string"
    ],
    "blockers": [
      "string"
    ],
    "declined_email": 0,
    "default_email_body": "string",
    "default_email_subject": "string",
    "default_send_at_local": "2026-10-29T12:00:00Z",
    "default_sends_immediately": false,
    "email_recipients": 0,
    "facility_id": "00000000-0000-4000-8000-000000000001",
    "gate_enabled": false,
    "imported_opt_outs_applied": false,
    "locked_audiences": [
      "existing_tenants"
    ],
    "no_email": 0,
    "postal_address_present": false,
    "sms_available": false,
    "sms_consented": 0,
    "suppressed": 0
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataLaunchPreviewResponserequired
Show data schema
audiencesAudienceCountResponse[]required
Show audiences schema
audiencestringrequired

Values: "existing_tenants", "recent_leads", "active_reservations", "abandoned_checkouts"

candidatesintegerrequired
eligible_emailintegerrequired
lockedbooleanrequired
blocker_messagesstring[]required
Show blocker_messages schema
string
blockersstring[]required
Show blockers schema
string
declined_emailintegerrequired
default_email_bodystringrequired
default_email_subjectstringrequired
default_send_at_localstringrequired

Format: date-time

default_sends_immediatelybooleanrequired
email_recipientsintegerrequired
facility_idstringrequired

Format: uuid

gate_enabledbooleanrequired
imported_opt_outs_appliedbooleanrequired
locked_audiencesstring[]required
Show locked_audiences schema
string

Values: "existing_tenants", "recent_leads", "active_reservations", "abandoned_checkouts"

no_emailintegerrequired
postal_address_presentbooleanrequired
sms_availablebooleanrequired
sms_consentedintegerrequired
suppressedintegerrequired
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 promotions operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Preview Facility Launch | Facily Developers