v4

latestOpenAPI 3.0.22026-08-02109239415.7 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 image is available.

cardstring nullable

Preferred app catalog thumbnail URL.

Response

Mini-app preview published successfully

preview_idstring required

Unique identifier of the published preview entry.

Example response

{
  "preview_id": "preview_id"
}