Skip to main content
POST
Upload a Blueprint ZIP bundle

Authorizations

Authorization
string
header
required

Personal API token, sent as Authorization: Bearer <SANDYWP_API_KEY>. Obtain one from the dashboard account menu (API keys), sandywp auth login, or POST /api/account/tokens. A missing or invalid token returns 401 auth_required. Scoped OAuth tokens are limited to the Imports family and GET /api/account/me; see the top-level conventions.

Query Parameters

preview
enum<string>

Set to 1 to inspect the bundle without saving it.

Available options:
1

Body

multipart/form-data
bundle
file

ZIP bundle to upload. Provide this or bundleUrl.

bundleUrl
string<uri>

URL of a ZIP bundle to fetch. Provide this or bundle.

name
string
description
string
adaptationsAccepted
enum<string>

Required when the compatibility review reports changes that need acceptance.

Available options:
true

Response

A saved Blueprint, or a bundle preview when preview=1.

blueprint
object
required

A saved Blueprint and its current compatibility report.