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

Create Promotion Launch

Promotions · REST API reference

Get support
POST/v1/promotions/{promotion_id}/launches
Schedule a launch: 201 when created; 200 when `Idempotency-Key` replays the launch an identical earlier request created; 409 for a reused key with a different body, and while the facility is not ready (gate off, imported opt-outs not applied, no postal address -- plan Decision 1, design 11.1, 11.3). The key is org-global, like every other `Idempotency-Key` here: callers send a client-generated UUID.

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/promotions/<PROMOTION_ID>/launches' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Idempotency-Key: <IDEMPOTENCY_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "audiences": [
    "existing_tenants"
  ],
  "email_body": "string",
  "email_subject": "string",
  "facility_id": "00000000-0000-4000-8000-000000000001",
  "channels": [
    "email"
  ],
  "send_at_local": "2026-10-29T12:00:00Z",
  "sms_body": "string"
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

promotion_idpath · stringrequired

Format: uuid

Idempotency-Keyheader · stringrequired

Min length: 1 · Max length: 100

Request body

application/json · Required

audiencesstring[]required

Min items: 1 · Max items: 4

Show audiences schema
string

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

channelsstring[]

Min items: 1 · Max items: 2

Show channels schema
string

Values: "email", "sms"

email_bodystringrequired

Min length: 1 · Max length: 20000

email_subjectstringrequired

Min length: 1 · Max length: 255

facility_idstringrequired

Format: uuid

send_at_localstring | null

Format: date-time

Show send_at_local schema
string | null
Variant 1: string
string
Variant 2: null
null
sms_bodystring | null

Max length: 480

Show sms_body 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.

201Successful 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"
  }
}

application/json

dataPromotionLaunchResponserequired
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
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

Create Promotion Launch | Facily Developers