Skip to content

Send a test of the launch announcement

POST /program/launch-announcement/test
Scopeprogram:write
Customer session tokenNot accepted: call from your server with an API key
Rate limit classwrite (limits)
Idempotency keyRequired (idempotency)
MCP toolcharm_send_launch_announcement_test

Sends the launch announcement once to one of the shop’s own addresses (the store e-mail by default, or its customer e-mail or reply-to). Any other address is refused. Shares the admin’s limit of test e-mails per hour.

FieldTypeDescription
tostringOne of the shop’s own addresses; defaults to the store e-mail. (optional)

Returns LaunchAnnouncementTestResult.

FieldTypeDescription
sentboolean
tostring
{
"sent": false,
"to": "to"
}
Terminal window
curl -X POST "https://charm.appfleece.app/api/v1/program/launch-announcement/test" \
-H "Authorization: Bearer chrm_live_..." \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"to":"to"}'

unauthorized · invalid_token · insufficient_scope · access_required · validation_error · rate_limited · idempotency_conflict

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