Sign in

v4

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

cardstring nullable

Preferred app catalog thumbnail URL.

Response

Mini-app published successfully

mini_app_idstring required

Unique identifier of the published mini-app.

slugstring required

Unique slug of the published mini-app.

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"
}