Skip to content

Get the launch announcement

GET /program/launch-announcement
Scopeprogram:read
Customer session tokenNot accepted: call from your server with an API key
Rate limit classread (limits)
Idempotency keyNot used
MCP toolcharm_get_launch_announcement

The one-off e-mail that tells existing members the program is live, with each member’s own balance: whether it was sent, how many members it reaches, and what blocks it (program_off, emails_off). Members a welcome e-mail reached in the last 90 days are left out and counted in welcomed_skipped.

Returns LaunchAnnouncement.

FieldTypeDescription
statusstring: idle, queued, running, done, failed
requested_atstring or null(nullable)
sent_atstring or null(nullable)
audienceintegerMembers it goes (or went) to.
sentintegerE-mails sent so far.
welcomed_skippedintegerMembers left out because a welcome e-mail reached them in the last 90 days.
can_sendboolean
blocked_bystring or null: new_shop, program_off, emails_offnew_shop: a shop can announce its launch 7 days after installing Charm (support can lift it). (nullable)
{
"status": "idle",
"requested_at": "2026-10-01T09:30:00.000Z",
"sent_at": "2026-10-01T09:30:00.000Z",
"audience": 1,
"sent": 1,
"welcomed_skipped": 1,
"can_send": false,
"blocked_by": "new_shop"
}
Terminal window
curl -X GET "https://charm.appfleece.app/api/v1/program/launch-announcement" \
-H "Authorization: Bearer chrm_live_..."

unauthorized · invalid_token · insufficient_scope · access_required · validation_error · rate_limited

Every error body carries code, message, request_id and a doc_url pointing at the matching entry in the error catalog.