Hanzo
OpenapiCampaign

Launch a campaign across every channel it declares

Pushes the campaign live on each of its channels through that channel's executor and answers the whole campaign with the per-channel outcome written back…

POST /v1/campaign/{id}/launch

Addresshttps://api.hanzo.ai/v1/campaign/{id}/launch
MethodPOST
Operationpost_campaign_by_id_launch
AuthAuthorization: Bearer $HANZO_API_KEY

Pushes the campaign live on each of its channels through that channel's executor and answers the whole campaign with the per-channel outcome written back onto it.

The fan-out is BEST-EFFORT PER CHANNEL, and the honest reading of the result is the rule most callers get wrong: one channel failing never aborts the others, so each channel row carries its own live, failed or unavailable status and detail, and a paid launch can be live while an email launch failed. The campaign itself is live when AT LEAST ONE channel launched and failed only when none did — live is not a claim that every channel launched. Repeating the call is safe: a channel already live is skipped, never re-launched. A campaign carrying more than one creative has its variant assigned here by the experiment seam and tagged as utm_content.

Org-scoped and fails closed: a valid bearer is required (403 without one), the campaign is read under the caller's OWN org so another tenant's id is a 404, and a campaign with no channels is a 400 — there is nothing to launch. Each executor resolves its own org's connector token from the org passed to it, so a launch can never spend through another tenant's connector.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyes

Response

The document declares no response body for this operation. It answers 200 on success and the platform error shape on failure — see Errors.

Examples

hanzo campaign launch <id>

Campaign API · All Hanzo APIs · Interactive reference

How is this guide?

On this page