/v1/promotions/{promotion_id}/launchesAuthentication
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 GET \
--url 'https://api.staging.facily.ai/v1/promotions/<PROMOTION_ID>/launches' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
promotion_idpath · stringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": [
{
"audiences": [
"existing_tenants"
],
"cancel_reason": "string",
"cancelled_at": "2026-10-29T12:00:00Z",
"channels": [
"email"
],
"completed_at": "2026-10-29T12:00:00Z",
"counts": {},
"created_at": "2026-10-29T12:00:00Z",
"created_by": "00000000-0000-4000-8000-000000000001",
"email_body": "string",
"email_subject": "string",
"facility_id": "00000000-0000-4000-8000-000000000001",
"id": "00000000-0000-4000-8000-000000000001",
"promotion_id": "00000000-0000-4000-8000-000000000001",
"recipient_count": 0,
"send_at": "2026-10-29T12:00:00Z",
"send_at_local": "2026-10-29T12:00:00Z",
"sms_body": "string",
"started_at": "2026-10-29T12:00:00Z",
"status": "scheduled"
}
],
"meta": {
"request_id": "string"
},
"pagination": {
"has_more": false,
"limit": 0,
"cursor": "string",
"total_count": 0
},
"metrics": {
"cards": {},
"computed_at": "2026-10-29T12:00:00Z",
"is_stale": false,
"scope": "facility"
}
}application/json
dataPromotionLaunchResponse[]requiredShow data schema
audiencesstring[]requiredShow audiences schema
stringValues: "existing_tenants", "recent_leads", "active_reservations", "abandoned_checkouts"
cancel_reasonstring | nullrequiredShow cancel_reason schema
string | nullVariant 1: string
stringVariant 2: null
nullcancelled_atstring | nullrequiredFormat: date-time
Show cancelled_at schema
string | nullVariant 1: string
stringVariant 2: null
nullchannelsstring[]requiredShow channels schema
stringValues: "email", "sms"
completed_atstring | nullrequiredFormat: date-time
Show completed_at schema
string | nullVariant 1: string
stringVariant 2: null
nullcountsobjectrequiredcreated_atstringrequiredFormat: date-time
created_bystringrequiredFormat: uuid
email_bodystring | nullrequiredShow email_body schema
string | nullVariant 1: string
stringVariant 2: null
nullemail_subjectstring | nullrequiredShow email_subject schema
string | nullVariant 1: string
stringVariant 2: null
nullfacility_idstringrequiredFormat: uuid
idstringrequiredFormat: uuid
promotion_idstringrequiredFormat: uuid
recipient_countinteger | nullrequiredShow recipient_count schema
integer | nullVariant 1: integer
integerVariant 2: null
nullsend_atstringrequiredFormat: date-time
send_at_localstringrequiredFormat: date-time
sms_bodystring | nullrequiredShow sms_body schema
string | nullVariant 1: string
stringVariant 2: null
nullstarted_atstring | nullrequiredFormat: date-time
Show started_at schema
string | nullVariant 1: string
stringVariant 2: null
nullstatusstringrequiredValues: "scheduled", "sending", "sent", "cancelled"
metaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequiredmetricsEmbeddedMetrics | nullShow metrics schema
EmbeddedMetrics | nullVariant 1: EmbeddedMetrics
cardsobjectrequiredcomputed_atstring | nullrequiredFormat: date-time
Show computed_at schema
string | nullVariant 1: string
stringVariant 2: null
nullis_stalebooleanrequiredscopestringrequiredValues: "facility", "portfolio"
Variant 2: null
nullpaginationPaginationBlockrequiredPagination metadata for list responses.
Show pagination schema
cursorstring | nullShow cursor schema
string | nullVariant 1: string
stringVariant 2: null
nullhas_morebooleanrequiredlimitintegerrequiredtotal_countinteger | nullShow total_count schema
integer | nullVariant 1: integer
integerVariant 2: null
null400Validation 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