Hanzo
OpenapiContent

Publish distributes one CMS content item to the channels recorded on it and…

Publish distributes one CMS content item to the channels recorded on it and returns the honest per-channel outcome.

POST /v1/content/publish

Addresshttps://api.hanzo.ai/v1/content/publish
MethodPOST
Operationpost_content_publish
AuthAuthorization: Bearer $HANZO_API_KEY

Publish distributes one CMS content item to the channels recorded on it and returns the honest per-channel outcome. The item names itself — its caption, media and channel list are read from the stored document, not from this request. It is idempotent per channel (a channel already posted for this item is skipped), and a publish that loses the per-item lease to a live publisher answers status "in_progress" having posted nothing.

Request

3 fields, body application/json (required).

FieldInTypeRequiredDescription
doctypebodystringDocType is the content type holding the item: Campaign, SocialPost or Asset.
namebodystringName is the document within that type — the item to distribute.
scheduleAtbodystringScheduleAt hands a future go-live to the channel's own scheduler, as an ISO-8601 time.

Response

StatusBodyMeaning
200PublishResultok

200 body — 10 fields.

FieldInTypeAlwaysDescription
channelsbodystring[]Channels is the channel list read off the content document — integration ids or provider names, as the item declares them.
externalIdsbodyobjectExternalIDs maps channel id → the post id that channel returned, merged with everything earlier publishes recorded.
externalIds.*bodystring
resultsbodyChannelResult[]Results is the outcome per channel — which went out, which did not and why — covering the whole fan-out including failures, so partial success is never…
results[].channelbodystringthe social integration id targeted
results[].errorbodystringshort reason, when it failed
results[].externalIdbodystringsocial post id, when it went out
results[].providerbodystring"x" | "instagram" | ...
results[].statusbodystring"distributed" | "scheduled" | "failed"
statusbodystringStatus is the ONE headline, drawn from: "distributed" (something is on record and went out now), "scheduled" (same, handed to the channel's own scheduler for…

Failure carries the platform error shape — see Errors.

Examples

hanzo content publish

Content API · All Hanzo APIs · Interactive reference

How is this guide?

On this page