Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsList Promotion Launches
Search the full API reference Esc to close

List Promotion Launches

Promotions · REST API reference

Get support
GET/v1/promotions/{promotion_id}/launches

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 GET \
  --url 'https://api.staging.facily.ai/v1/promotions/<PROMOTION_ID>/launches' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Try a request

Staging · read-only

Explore your organization with a read-only request to staging.

Kept in this tab only. Sent directly to api.staging.facily.ai.

GET

Replace the {placeholders} in the path with your resource IDs.

Response
Your response will appear here.

Parameters

promotion_idpath · stringrequired

Format: uuid

Responses

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

200Successful Response
JSON · generated example
{
  "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[]required
Show data schema
audiencesstring[]required
Show audiences schema
string

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

cancel_reasonstring | nullrequired
Show cancel_reason schema
string | null
Variant 1: string
string
Variant 2: null
null
cancelled_atstring | nullrequired

Format: date-time

Show cancelled_at schema
string | null
Variant 1: string
string
Variant 2: null
null
channelsstring[]required
Show channels schema
string

Values: "email", "sms"

completed_atstring | nullrequired

Format: date-time

Show completed_at schema
string | null
Variant 1: string
string
Variant 2: null
null
countsobjectrequired
created_atstringrequired

Format: date-time

created_bystringrequired

Format: uuid

email_bodystring | nullrequired
Show email_body schema
string | null
Variant 1: string
string
Variant 2: null
null
email_subjectstring | nullrequired
Show email_subject schema
string | null
Variant 1: string
string
Variant 2: null
null
facility_idstringrequired

Format: uuid

idstringrequired

Format: uuid

promotion_idstringrequired

Format: uuid

recipient_countinteger | nullrequired
Show recipient_count schema
integer | null
Variant 1: integer
integer
Variant 2: null
null
send_atstringrequired

Format: date-time

send_at_localstringrequired

Format: date-time

sms_bodystring | nullrequired
Show sms_body schema
string | null
Variant 1: string
string
Variant 2: null
null
started_atstring | nullrequired

Format: date-time

Show started_at schema
string | null
Variant 1: string
string
Variant 2: null
null
statusstringrequired

Values: "scheduled", "sending", "sent", "cancelled"

metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
metricsEmbeddedMetrics | null
Show metrics schema
EmbeddedMetrics | null
Variant 1: EmbeddedMetrics
cardsobjectrequired
computed_atstring | nullrequired

Format: date-time

Show computed_at schema
string | null
Variant 1: string
string
Variant 2: null
null
is_stalebooleanrequired
scopestringrequired

Values: "facility", "portfolio"

Variant 2: null
null
paginationPaginationBlockrequired

Pagination metadata for list responses.

Show pagination schema
cursorstring | null
Show cursor schema
string | null
Variant 1: string
string
Variant 2: null
null
has_morebooleanrequired
limitintegerrequired
total_countinteger | null
Show total_count schema
integer | null
Variant 1: integer
integer
Variant 2: null
null
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

List Promotion Launches | Facily Developers