v7

latestOpenAPI 3.0.22026-08-08114248430.1 KB

mini-apps

Publish a mini-app preview entry

Publishes a mini-app preview entry. Called by the mini-apps preview deploy pipeline to register a throwaway preview deploy, keyed by its unique preview id. Re-publishing an existing preview id refreshes every deploy-managed field. Preview entries are independent from the main catalog: they carry no slug, owner, or membership gating, and anyone with the preview link can access the app.

post/mini-apps/publish-preview

Request body

iconstring nullable

Square mini-app icon URL.

coverstring nullable

Cover image or video URL used when no card artwork is available. Video URL paths must end in .mp4 or .webm.

cardstring nullable

Preferred app catalog image or video thumbnail URL. Video URL paths must end in .mp4 or .webm.

Response

Mini-app preview published successfully

preview_idstring required

Unique, URL-safe preview identifier composed by the deploy pipeline.

Example response

{
  "preview_id": "preview_id"
}