ZAzalster
banners

Create Banner

A banner: the headline, subline, call to action and badge asked for, the chosen products' own pictures with their names and prices, the brand's logo, colours and faces, on a kit colour or a picture sent as a data: URI. Drawn now and kept behind image_url until expires_at. preview: true adds a small JPEG of it, base64, for a chat to show. 400 for products that are not active or a picture that cannot be read; 503 banner-busy when the render worker cannot draw it in time.

post/companies/{company_id}/banners

Request

  • Base URL
    https://app.zalster.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

company_idstring uuid required

Company id

Request body

headlinestring required
sublinestring nullable
ctastring nullable
badgestring nullable
product_idsstring[]
shape'wide' | 'square' | 'portrait' | 'story'
groundstring nullable
picturestring nullable
pricesboolean
previewboolean

Response

Successful Response

idstring uuid required
image_urlstring nullable required
widthinteger required
heightinteger required
shapestring required
expires_atstring date-time required
warningsstring[]
previewstring nullable
preview_media_typestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.