GuidesAPI ReferenceMCPChangelog
Shared

Live "will reach N" count for a segment or tag

get/api/marketing/campaigns/{id}/audience-count

The compose screen's live audience preview, debounced against IN-MEMORY form state rather than the saved draft: it has to answer before autosave persists. {id} is not read; kept only for URL consistency with the rest of this feature's nested routes, since the count depends purely on company + kind + value. The emailable/consent filter (applyMarketingAudienceFilter, migration 0143) is always applied on top, same as the clients page's own emailable chip.

Authorization

sessionCookie
sb-qxrvgfkjyvbngipqvslu-auth-token<token>

The dashboard's Supabase Auth session cookie, set at sign-in. Large sessions are split across numbered chunks (…auth-token.0, .1), so treat this as a cookie family rather than one name.

Every request re-validates it against the Auth server (getUser()), never by decoding the cookie locally: a JWT nothing has checked is not a credential. Tenancy is then read from the verified app_metadata.company_id claim and enforced by row-level security; it is never read from request input, on any route, ever.

role (admin / staff) is deliberately not in RLS. It gates specific actions in route code, the operations marked admin below, so hiding a button in the UI is cosmetic only, and a route's own check is the enforcement.

In: cookie

Path Parameters

id*string

Campaign id (unused by the handler; see description).

Query Parameters

kind*string

Which audience-picker mode this count is for.

Value in

  • "segment"
  • "tag"
value?string

A ClientSegment id when kind='segment', or a free-text tag when kind='tag'. An empty tag short-circuits to {reach:0} without a query.

Lengthlength <= 60

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/marketing/campaigns/string/audience-count?kind=segment"
{  "reach": 0}

Remove a campaign photo (admin, or manage_org_settings) DELETE

Deletes the object and nulls `photo_url`. Draft-only. Takes no body.

Render a live email preview of a draft campaign POST

A server round trip, DELIBERATELY not a zero-round-trip client-side render the way TemplateStudio.tsx's own preview works: {{booking_url}} resolves through appBaseUrl() (booking/manage.ts), which reads a server-only environment variable Next.js never inlines into a client bundle. Draft fields are read from the REQUEST BODY, never the saved row, since the point is previewing what the operator has typed but not yet autosaved. Renders against a fixed sample customer name, the same "real renderer against a sample" approach TemplateStudio.tsx uses for its own booking preview.