Creatives

Upload artwork

Upload the advert artwork from a public https image URL (PNG or JPEG) or base64. It is converted to the screen's 800 × 480 six-colour e-paper format (render bold, the default, for flat-colour graphics and text; smooth for photos; or auto) and checked for nudity and profanity. Returns a creative_id and an image of what the screen will show. Photos work; large, high-contrast words read best from a distance. Needs scope quote. Over HTTP the file (PNG or JPEG up to 10 MB, or a ready-made 192,000-byte panel file) can also be sent as multipart field "file" or as a raw image body.

post/creatives

Request

  • Base URL: https://wall.marketing/api/v1
  • URL: https://wall.marketing/api/v1/creatives
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Repeat a request with the same key to get the first response instead of acting twice. Kept for 24 hours.

Request body

image_urlstring uri
image_base64string
namestring
fit'cover' | 'stretch'
render'auto' | 'bold' | 'smooth'

Response

Created

objectstring

Always "creative".

idstring

The creative_id to book with.

livemodeboolean

False in the sandbox.

namestring nullable

The name given at upload.

statusstring

Always "approved": artwork that fails the checks is refused at upload.

sourcestring nullable

How it arrived: image, or a ready-made panel file.

original_typestring nullable

The uploaded file's type.

renderstring nullable

bold or smooth: how the image was converted to the panel's colours.

preview_urlstring

PNG of exactly what the screen will show.

created_atstring nullable

When it was uploaded. ISO 8601, UTC.

Changes

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