Skip to main content
POST
/
api
/
public
/
v1
/
plugins
/
v2
/
deploy
Deploy plugin with inline assets (V2)
curl --request POST \
  --url http://app.localhost:3000/api/public/v1/plugins/v2/deploy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "manifest": {
    "name": "<string>",
    "version": "<string>",
    "pages": [
      {
        "id": "<string>",
        "path": "<string>",
        "name": "<string>",
        "isDefault": true,
        "remappable": true,
        "features": [
          {
            "type": "<string>",
            "requirements": "<array>"
          }
        ],
        "editor": {
          "type": "internal",
          "url": "<string>"
        }
      }
    ],
    "description": "<string>",
    "category": "<string>",
    "tags": [
      "<string>"
    ],
    "mode": "spa-mode",
    "requirements": {
      "sdk": "<string>",
      "sdkVersion": "<string>"
    },
    "config": {},
    "ui": {
      "hideDesignSelector": true,
      "hideVersionSelector": true,
      "hideConfigEditor": true
    }
  },
  "storeId": "<string>",
  "inlineAssets": [
    {
      "path": "<string>",
      "content": "<string>",
      "contentType": "<string>"
    }
  ],
  "demoPreviews": {
    "pages": [
      {
        "path": "<string>",
        "previews": [
          {
            "id": "<string>",
            "previewUrl": "<string>",
            "metadata": {
              "status": "pending",
              "preset": "<string>",
              "capturedAt": "<string>",
              "error": "<string>"
            },
            "screenshotUrls": {
              "mobile": "<string>",
              "desktop": "<string>"
            }
          }
        ],
        "name": "<string>"
      }
    ],
    "metadata": {
      "lastUpdated": "<string>",
      "generator": "<string>",
      "version": "<string>"
    }
  },
  "sourceData": {},
  "overwrite": false,
  "autoInstantiate": {
    "stepType": "<string>",
    "funnelId": "<string>",
    "isPreview": true
  }
}
'
{
  "message": "<string>",
  "code": "<string>",
  "issues": [
    {
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
manifest
object
required
storeId
string
required
Minimum string length: 1
inlineAssets
object[]
required
demoPreviews
object
sourceData
object
overwrite
boolean
default:false
autoInstantiate
object

Response

Successful response