Sign in

v7

latestOpenAPI 3.0.22026-08-08114248430.1 KB
mini-apps

Publish a mini-app catalog entry

Publishes a mini-app's catalog entry. Called by the mini-apps deploy pipeline after a deploy to register or refresh a single app, keyed by its unique slug. Re-publishing an existing app refreshes the deploy-managed fields (label, description, embed mode, scopes, image-input support, deployment details, and website) while leaving administrator-managed settings and artwork untouched. Artwork from the request is used only when creating a new app.

post/mini-apps/publish

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 published successfully

mini_app_idstring required

Unique identifier of the published mini-app.

slugstring required

Unique, stable, URL-safe mini-app identifier.

requires_membershipboolean required

Whether the mini-app requires a membership to access.

archivedboolean required

Whether the mini-app is currently archived (hidden from the catalog).

Example response

{
  "archived": true,
  "mini_app_id": "mini_app_id",
  "requires_membership": true,
  "slug": "slug"
}