POST/api/v1/exports

Exports

Build the .zip packages for an ad platform, follow their status and download them checking the sha-256.

An export packages a campaign's pieces as HTML5 with clickTag, ready to upload to the platform you choose. It requires the export permission and accepts Idempotency-Key. What is approved is what is exported: if the workspace requires approval and pieces are still unapproved, the response is 409 and nothing is exported.

Create an export

FieldRequirementDescription

campaignIdstring

Required

The campaign to export.

creativeIdsstring[]

Optional

From 1 to 50 concepts. If omitted, all of the campaign's.

sizesstring[]

Optional

If omitted, the campaign's.

localesstring[]

Optional

If omitted, the campaign's.

packagingstring

Optional

per_piece (one .zip per piece, default), per_size (one per size) or single (a single one).

profileIdstring

Optional

Platform profile: generic, google-ads, cm360, dv360, amazon-dsp, ttd, adform, flashtalking. If omitted, the campaign's.

clickUrlstring

Optional

Destination URL of the clickTag; it must start with http:// or https://.

validateWeightboolean

Optional

Validates the weight against the profile's limit.

It responds 202 with exports (one per concept: id, status, statusUrl and downloadUrl) and unapproved, the pieces not yet approved. The export is one more job: when it finishes you will receive the export.ready webhook (or export.failed).

Status and pieces

GET /api/v1/exports/:id returns the status (queued, running, ready, warnings, failed or expired), the profile, the size in bytes, the .zip's artifactSha256, the pieces with their weight and warnings (items) and the validator's checks (checks). GET /api/v1/exports lists them, with an optional campaignId and cursor pagination.

Download the .zip

GET /api/v1/exports/:id/download returns the package (application/zip) with the X-Content-SHA256 header: compute the sha-256 of what you downloaded and compare it. If the export is not ready yet it responds 409; if it has expired, 410 (expired).

Nota. Today BannerMotion builds the package for each platform but does not upload it for you: direct delivery to an ad server is in development.

Job statusCheck a generation job or follow it live with SSE events.Webhook eventsThe 13 events, all emitted today: when they fire, what the data field carries and an example of each.MCP serverConnect Claude, Cursor or ChatGPT to BannerMotion: 10 tools to generate, correct, view and export banners.

Esta página foi útil?