/v1/promotions/{promotion_id}/launches/previewAuthentication
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 POST \
--url 'https://api.staging.facily.ai/v1/promotions/<PROMOTION_ID>/launches/preview' \
--header "Authorization: Bearer $FACILY_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"facility_id": "00000000-0000-4000-8000-000000000001",
"audiences": [
"existing_tenants"
],
"valid_from": "2026-10-29"
}'Parameters
promotion_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
audiencesstring[]Max items: 4
Show audiences schema
stringValues: "existing_tenants", "recent_leads", "active_reservations", "abandoned_checkouts"
facility_idstringrequiredFormat: uuid
valid_fromstring | nullFormat: date
Show valid_from schema
string | nullVariant 1: string
stringVariant 2: null
nullResponses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"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
dataLaunchPreviewResponserequiredShow data schema
audiencesAudienceCountResponse[]requiredShow audiences schema
audiencestringrequiredValues: "existing_tenants", "recent_leads", "active_reservations", "abandoned_checkouts"
candidatesintegerrequiredeligible_emailintegerrequiredlockedbooleanrequiredblocker_messagesstring[]requiredShow blocker_messages schema
stringblockersstring[]requiredShow blockers schema
stringdeclined_emailintegerrequireddefault_email_bodystringrequireddefault_email_subjectstringrequireddefault_send_at_localstringrequiredFormat: date-time
default_sends_immediatelybooleanrequiredemail_recipientsintegerrequiredfacility_idstringrequiredFormat: uuid
gate_enabledbooleanrequiredimported_opt_outs_appliedbooleanrequiredlocked_audiencesstring[]requiredShow locked_audiences schema
stringValues: "existing_tenants", "recent_leads", "active_reservations", "abandoned_checkouts"
no_emailintegerrequiredpostal_address_presentbooleanrequiredsms_availablebooleanrequiredsms_consentedintegerrequiredsuppressedintegerrequiredmetaMetarequiredEnvelope 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