Hanzo
OpenapiMarketing

Returns one of the caller org's campaigns.

Returns one of the caller org's campaigns.

GET /v1/marketing/campaigns/{id}

Addresshttps://api.hanzo.ai/v1/marketing/campaigns/{id}
MethodGET
Operationget_marketing_campaigns_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one of the caller org's campaigns. A campaign belonging to another org reads as not found.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the campaign id from the path, as returned by create.

Response

StatusBodyMeaning
200Campaignok

200 body — 10 fields.

FieldInTypeAlwaysDescription
budgetbodyintegerBudget is what the campaign is allowed to cost, in USD cents.
channelbodystringChannel is the delivery surface: email, sms, social, meta, google or tiktok.
createdAtbodyintegerCreatedAt is unix seconds when the campaign was registered.
idbodystringID is the server-assigned campaign id ("camp_" + 128 random bits).
namebodystringName is the campaign's label.
objectivebodystringObjective is the free-text goal ("signups"), capped at 1024 bytes.
scheduledAtbodyintegerScheduledAt is the unix send time; 0 means unscheduled.
spendbodyintegerSpend is what the campaign has cost so far, in USD cents, clamped to >= 0.
statusbodystringStatus is the lifecycle: draft, scheduled, active, paused or completed.
updatedAtbodyintegerUpdatedAt is unix seconds of the last write.

Failure carries the platform error shape — see Errors.

Examples

hanzo marketing campaigns get <id>

Marketing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page