Configure the template's public launch link

curl --request POST \
  --url https://app.sandywp.com/api/app/templates/{id}/launch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "landingPath": "/wp-admin/",
  "branding": {
    "eyebrow": "<string>",
    "headline": "<string>",
    "subhead": "<string>",
    "buttonLabel": "<string>",
    "logoUrl": "<string>",
    "brandName": "<string>",
    "accentColor": "#3366ff",
    "backgroundColor": "<string>",
    "backgroundImageUrl": "<string>",
    "hidePoweredBy": true
  },
  "protected": true
}
'

import requests

url = "https://app.sandywp.com/api/app/templates/{id}/launch"

payload = {
    "landingPath": "/wp-admin/",
    "branding": {
        "eyebrow": "<string>",
        "headline": "<string>",
        "subhead": "<string>",
        "buttonLabel": "<string>",
        "logoUrl": "<string>",
        "brandName": "<string>",
        "accentColor": "#3366ff",
        "backgroundColor": "<string>",
        "backgroundImageUrl": "<string>",
        "hidePoweredBy": True
    },
    "protected": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    landingPath: '/wp-admin/',
    branding: {
      eyebrow: '<string>',
      headline: '<string>',
      subhead: '<string>',
      buttonLabel: '<string>',
      logoUrl: '<string>',
      brandName: '<string>',
      accentColor: '#3366ff',
      backgroundColor: '<string>',
      backgroundImageUrl: '<string>',
      hidePoweredBy: true
    },
    protected: true
  })
};

fetch('https://app.sandywp.com/api/app/templates/{id}/launch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sandywp.com/api/app/templates/{id}/launch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'landingPath' => '/wp-admin/',
    'branding' => [
        'eyebrow' => '<string>',
        'headline' => '<string>',
        'subhead' => '<string>',
        'buttonLabel' => '<string>',
        'logoUrl' => '<string>',
        'brandName' => '<string>',
        'accentColor' => '#3366ff',
        'backgroundColor' => '<string>',
        'backgroundImageUrl' => '<string>',
        'hidePoweredBy' => true
    ],
    'protected' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sandywp.com/api/app/templates/{id}/launch"

	payload := strings.NewReader("{\n  \"landingPath\": \"/wp-admin/\",\n  \"branding\": {\n    \"eyebrow\": \"<string>\",\n    \"headline\": \"<string>\",\n    \"subhead\": \"<string>\",\n    \"buttonLabel\": \"<string>\",\n    \"logoUrl\": \"<string>\",\n    \"brandName\": \"<string>\",\n    \"accentColor\": \"#3366ff\",\n    \"backgroundColor\": \"<string>\",\n    \"backgroundImageUrl\": \"<string>\",\n    \"hidePoweredBy\": true\n  },\n  \"protected\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.sandywp.com/api/app/templates/{id}/launch")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"landingPath\": \"/wp-admin/\",\n  \"branding\": {\n    \"eyebrow\": \"<string>\",\n    \"headline\": \"<string>\",\n    \"subhead\": \"<string>\",\n    \"buttonLabel\": \"<string>\",\n    \"logoUrl\": \"<string>\",\n    \"brandName\": \"<string>\",\n    \"accentColor\": \"#3366ff\",\n    \"backgroundColor\": \"<string>\",\n    \"backgroundImageUrl\": \"<string>\",\n    \"hidePoweredBy\": true\n  },\n  \"protected\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.sandywp.com/api/app/templates/{id}/launch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"landingPath\": \"/wp-admin/\",\n  \"branding\": {\n    \"eyebrow\": \"<string>\",\n    \"headline\": \"<string>\",\n    \"subhead\": \"<string>\",\n    \"buttonLabel\": \"<string>\",\n    \"logoUrl\": \"<string>\",\n    \"brandName\": \"<string>\",\n    \"accentColor\": \"#3366ff\",\n    \"backgroundColor\": \"<string>\",\n    \"backgroundImageUrl\": \"<string>\",\n    \"hidePoweredBy\": true\n  },\n  \"protected\": true\n}"

response = http.request(request)
puts response.read_body

{
  "template": {
    "id": "tpl_xyz789",
    "userId": "<string>",
    "orgId": "<string>",
    "createdByUserId": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "description": "<string>",
    "sourceSiteId": "<string>",
    "artifactId": "<string>",
    "failureReason": "<string>",
    "wordpressVersion": "<string>",
    "phpVersion": "<string>",
    "sizeBytes": 123,
    "launchEnabled": true,
    "launchToken": "<string>",
    "launchCount": 123,
    "launchExpirationMinutes": 123,
    "launchLandingPath": "/wp-admin/",
    "launchBranding": {
      "eyebrow": "<string>",
      "headline": "<string>",
      "subhead": "<string>",
      "buttonLabel": "<string>",
      "logoUrl": "<string>",
      "brandName": "<string>",
      "accentColor": "#3366ff",
      "backgroundColor": "<string>",
      "backgroundImageUrl": "<string>",
      "hidePoweredBy": true
    },
    "launchProtected": true,
    "sourceBlueprintId": "<string>",
    "sourceBlueprintRevision": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "auth_required",
    "message": "A logged-in user is required.",
    "details": {}
  }
}

{
  "error": {
    "code": "template_sharing_requires_paid_plan",
    "message": "Sharing a template as a public link requires a paid plan.",
    "details": {
      "plan": "free"
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "template_not_found",
    "message": "Template not found.",
    "details": {}
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {}
  }
}

Templates

Configure the template's public launch link

Manages the Template’s public “launch this demo” link at <origin>/launch/<launchToken>. One endpoint, four actions selected by action:

enable — turn the link on. Mints a launchToken if the Template doesn’t already have one. Only valid on a "ready" Template (409 template_not_ready otherwise). Requires a paid plan (402 template_sharing_requires_paid_plan).
rotate — mint a new launchToken, invalidating the old URL, and ensure the link is enabled. Same 409/402 gates as enable.
disable — turn the link off. Free, so a downgraded owner can always turn an existing link off.
update — change launcher settings (quotaMode, entryMode, expirationMode, expirationMinutes, landingPath, branding, protected) without touching whether the link is enabled. Free, no plan gate.

Templates expose launchExpirationMode and launchExpirationMinutes on every response; a null minute value means fixed demos default to 24 hours (1440) and inactivity demos default to 1 hour (60). Both are capped by the server’s configured maximum demo lifetime.

POST

api

app

templates

{id}

launch

Configure the template's public launch link

curl --request POST \
  --url https://app.sandywp.com/api/app/templates/{id}/launch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "landingPath": "/wp-admin/",
  "branding": {
    "eyebrow": "<string>",
    "headline": "<string>",
    "subhead": "<string>",
    "buttonLabel": "<string>",
    "logoUrl": "<string>",
    "brandName": "<string>",
    "accentColor": "#3366ff",
    "backgroundColor": "<string>",
    "backgroundImageUrl": "<string>",
    "hidePoweredBy": true
  },
  "protected": true
}
'

import requests

url = "https://app.sandywp.com/api/app/templates/{id}/launch"

payload = {
    "landingPath": "/wp-admin/",
    "branding": {
        "eyebrow": "<string>",
        "headline": "<string>",
        "subhead": "<string>",
        "buttonLabel": "<string>",
        "logoUrl": "<string>",
        "brandName": "<string>",
        "accentColor": "#3366ff",
        "backgroundColor": "<string>",
        "backgroundImageUrl": "<string>",
        "hidePoweredBy": True
    },
    "protected": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    landingPath: '/wp-admin/',
    branding: {
      eyebrow: '<string>',
      headline: '<string>',
      subhead: '<string>',
      buttonLabel: '<string>',
      logoUrl: '<string>',
      brandName: '<string>',
      accentColor: '#3366ff',
      backgroundColor: '<string>',
      backgroundImageUrl: '<string>',
      hidePoweredBy: true
    },
    protected: true
  })
};

fetch('https://app.sandywp.com/api/app/templates/{id}/launch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sandywp.com/api/app/templates/{id}/launch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'landingPath' => '/wp-admin/',
    'branding' => [
        'eyebrow' => '<string>',
        'headline' => '<string>',
        'subhead' => '<string>',
        'buttonLabel' => '<string>',
        'logoUrl' => '<string>',
        'brandName' => '<string>',
        'accentColor' => '#3366ff',
        'backgroundColor' => '<string>',
        'backgroundImageUrl' => '<string>',
        'hidePoweredBy' => true
    ],
    'protected' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sandywp.com/api/app/templates/{id}/launch"

	payload := strings.NewReader("{\n  \"landingPath\": \"/wp-admin/\",\n  \"branding\": {\n    \"eyebrow\": \"<string>\",\n    \"headline\": \"<string>\",\n    \"subhead\": \"<string>\",\n    \"buttonLabel\": \"<string>\",\n    \"logoUrl\": \"<string>\",\n    \"brandName\": \"<string>\",\n    \"accentColor\": \"#3366ff\",\n    \"backgroundColor\": \"<string>\",\n    \"backgroundImageUrl\": \"<string>\",\n    \"hidePoweredBy\": true\n  },\n  \"protected\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.sandywp.com/api/app/templates/{id}/launch")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"landingPath\": \"/wp-admin/\",\n  \"branding\": {\n    \"eyebrow\": \"<string>\",\n    \"headline\": \"<string>\",\n    \"subhead\": \"<string>\",\n    \"buttonLabel\": \"<string>\",\n    \"logoUrl\": \"<string>\",\n    \"brandName\": \"<string>\",\n    \"accentColor\": \"#3366ff\",\n    \"backgroundColor\": \"<string>\",\n    \"backgroundImageUrl\": \"<string>\",\n    \"hidePoweredBy\": true\n  },\n  \"protected\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.sandywp.com/api/app/templates/{id}/launch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"landingPath\": \"/wp-admin/\",\n  \"branding\": {\n    \"eyebrow\": \"<string>\",\n    \"headline\": \"<string>\",\n    \"subhead\": \"<string>\",\n    \"buttonLabel\": \"<string>\",\n    \"logoUrl\": \"<string>\",\n    \"brandName\": \"<string>\",\n    \"accentColor\": \"#3366ff\",\n    \"backgroundColor\": \"<string>\",\n    \"backgroundImageUrl\": \"<string>\",\n    \"hidePoweredBy\": true\n  },\n  \"protected\": true\n}"

response = http.request(request)
puts response.read_body

{
  "template": {
    "id": "tpl_xyz789",
    "userId": "<string>",
    "orgId": "<string>",
    "createdByUserId": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "description": "<string>",
    "sourceSiteId": "<string>",
    "artifactId": "<string>",
    "failureReason": "<string>",
    "wordpressVersion": "<string>",
    "phpVersion": "<string>",
    "sizeBytes": 123,
    "launchEnabled": true,
    "launchToken": "<string>",
    "launchCount": 123,
    "launchExpirationMinutes": 123,
    "launchLandingPath": "/wp-admin/",
    "launchBranding": {
      "eyebrow": "<string>",
      "headline": "<string>",
      "subhead": "<string>",
      "buttonLabel": "<string>",
      "logoUrl": "<string>",
      "brandName": "<string>",
      "accentColor": "#3366ff",
      "backgroundColor": "<string>",
      "backgroundImageUrl": "<string>",
      "hidePoweredBy": true
    },
    "launchProtected": true,
    "sourceBlueprintId": "<string>",
    "sourceBlueprintRevision": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "auth_required",
    "message": "A logged-in user is required.",
    "details": {}
  }
}

{
  "error": {
    "code": "template_sharing_requires_paid_plan",
    "message": "Sharing a template as a public link requires a paid plan.",
    "details": {
      "plan": "free"
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "template_not_found",
    "message": "Template not found.",
    "details": {}
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {}
  }
}

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.

Headers

X-SandyWP-Workspace

string

Selects which of the caller's workspaces to act in, for accounts belonging to more than one (legacy alias: X-SandyWP-Organization). Defaults to the caller's own personal workspace when omitted. Every id in this API (sandboxes, Templates, repositories) is scoped to a single workspace, so this header changes which set of resources is visible.

Path Parameters

string

required

The template id.

Body

application/json

action

enum<string>

required

Required. What to do with the launcher.

Available options:

enable,

disable,

rotate,

update

quotaMode

enum<string>

update only. Who a launched demo counts against: visitor (default; the visitor's own quota) or owner (the Template owner's plan slots).

Available options:

visitor,

owner

entryMode

enum<string>

update only. anonymous (default; straight to an auto-login demo) or email (capture an email first, recorded as a lead — see GET /api/app/templates/{id}/leads).

Available options:

anonymous,

email

expirationMode

enum<string>

update only. fixed expires each demo after a fixed lifetime; inactivity renews the deadline while the visitor actively uses WordPress (a background tab, including WordPress heartbeat polling, does not renew it).

Available options:

fixed,

inactivity

expirationMinutes

enum<integer>

update only. Allowed values depend on expirationMode and are NOT a flat enum: fixed lifetimes accept 60, 420, 1440, 4320, or 10080 minutes; inactivity lifetimes accept 10, 30, 60, or 1440 minutes. Values above the server's configured maximum demo lifetime are rejected regardless of mode. Omitting this while switching expirationMode applies that mode's default (1440 for fixed, 60 for inactivity).

Available options:

10,

30,

60,

420,

1440,

4320,

10080

landingPath

string

update only. Sandbox-local path opened after auto-login, e.g. /, /shop/, or /wp-admin/ (default). Must start with /, must not start with //, and may carry a query string / fragment for deep links into wp-admin.

Example:

"/wp-admin/"

branding

object | null

update only. Custom copy/colors for the public landing page, or null to clear it. Unknown/invalid sub-fields are silently dropped rather than rejected.

Show child attributes

protected

boolean

update only. Protected demo, true by default. When true, every demo launched from this link (after the change) gets DISALLOW_FILE_MODS and DISALLOW_FILE_EDIT written into its wp-config.php, so visitors get wp-admin without the plugin/theme installer, the ZIP uploader, or the file editor.

Response

The updated Template.

template

object

required

A reusable snapshot of a finished sandbox.

Show child attributes

Delete a template List a template's captured launch leads

Getting started

Using sandboxes

Tools

Integrations

Automation guides

API Reference

Configure the template's public launch link

Authorizations

Headers

Path Parameters

Body

Response