Update an existing PSD mockup

const response = await fetch("https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  method: "PATCH",
  headers: {
    "x-api-key": "sm_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Updated Mockup Name"
  }),
});

const data = await response.json();
console.log(data);

<?php

$payload = <<<'JSON'
{
  "name": "Updated Mockup Name"
}
JSON;

$ch = curl_init("https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: sm_your_api_key",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

import requests

payload = {
    "name": "Updated Mockup Name"
}

response = requests.patch(
    "https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6",
    headers={"x-api-key": "sm_your_api_key"},
    json=payload,
)

response.raise_for_status()
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6")
request = Net::HTTP::Patch.new(uri)
request["x-api-key"] = "sm_your_api_key"
request["Content-Type"] = "application/json"

request.body = <<~JSON
  {
    "name": "Updated Mockup Name"
  }
JSON

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts response.body

package main

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

func main() {
	payload := []byte(`{
  "name": "Updated Mockup Name"
}`)

	req, err := http.NewRequest("PATCH", "https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("x-api-key", "sm_your_api_key")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

String payload = """
{
  "name": "Updated Mockup Name"
}
""";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6"))
    .header("x-api-key", "sm_your_api_key")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString(payload))
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

using System.Net.Http;
using System.Text;

var payload = """
{
  "name": "Updated Mockup Name"
}
""";

var request = new HttpRequestMessage(HttpMethod.Patch, "https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6");
request.Headers.Add("x-api-key", "sm_your_api_key");
request.Content = new StringContent(payload, Encoding.UTF8, "application/json");

var client = new HttpClient();
var response = await client.SendAsync(request);

Console.WriteLine(await response.Content.ReadAsStringAsync());

curl -X PATCH "https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "x-api-key: sm_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Mockup Name"
  }'

{
  "data": {
    "collections": [],
    "group_layers": [],
    "height": 5000,
    "name": "Heavyweight tee front",
    "smart_objects": [
      {
        "blend_mode": "multiply",
        "layer_name": "Front print",
        "name": "Front print",
        "position": {
          "height": 3413,
          "width": 3000,
          "x": 512,
          "y": 730
        },
        "print_area_presets": [
          {
            "name": "Default",
            "position": {
              "height": 3413,
              "width": 3000,
              "x": 0,
              "y": 0
            },
            "size": {
              "height": 3413,
              "width": 3000
            },
            "thumbnails": [],
            "uuid": "d07f5b18-2c94-4e83-a6b1-95f3c8e27a40"
          }
        ],
        "quad": [
          [
            512.0,
            742.0
          ],
          [
            3512.0,
            730.0
          ],
          [
            3499.0,
            4143.0
          ],
          [
            524.0,
            4131.0
          ]
        ],
        "size": {
          "height": 3413,
          "width": 3000
        },
        "uuid": "b41a7e52-93c8-4d61-8f07-2ae5c9d04713"
      }
    ],
    "text_layers": [],
    "thumbnail": "https://cdn.sudomock.com/thumbnails/8f2c1d90_720.webp",
    "thumbnails": [
      {
        "url": "https://cdn.sudomock.com/thumbnails/8f2c1d90_720.webp",
        "width": 720
      },
      {
        "url": "https://cdn.sudomock.com/thumbnails/8f2c1d90_480.webp",
        "width": 480
      },
      {
        "url": "https://cdn.sudomock.com/thumbnails/8f2c1d90_240.webp",
        "width": 240
      }
    ],
    "uuid": "8f2c1d90-6b4e-4a37-9e55-0d1c7a3f21b8",
    "width": 4000
  },
  "message": "",
  "success": true
}

PATCH

api

psd-mockups

{uuid}

const response = await fetch("https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  method: "PATCH",
  headers: {
    "x-api-key": "sm_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Updated Mockup Name"
  }),
});

const data = await response.json();
console.log(data);

<?php

$payload = <<<'JSON'
{
  "name": "Updated Mockup Name"
}
JSON;

$ch = curl_init("https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: sm_your_api_key",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

import requests

payload = {
    "name": "Updated Mockup Name"
}

response = requests.patch(
    "https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6",
    headers={"x-api-key": "sm_your_api_key"},
    json=payload,
)

response.raise_for_status()
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6")
request = Net::HTTP::Patch.new(uri)
request["x-api-key"] = "sm_your_api_key"
request["Content-Type"] = "application/json"

request.body = <<~JSON
  {
    "name": "Updated Mockup Name"
  }
JSON

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts response.body

package main

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

func main() {
	payload := []byte(`{
  "name": "Updated Mockup Name"
}`)

	req, err := http.NewRequest("PATCH", "https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("x-api-key", "sm_your_api_key")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

String payload = """
{
  "name": "Updated Mockup Name"
}
""";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6"))
    .header("x-api-key", "sm_your_api_key")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString(payload))
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

using System.Net.Http;
using System.Text;

var payload = """
{
  "name": "Updated Mockup Name"
}
""";

var request = new HttpRequestMessage(HttpMethod.Patch, "https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6");
request.Headers.Add("x-api-key", "sm_your_api_key");
request.Content = new StringContent(payload, Encoding.UTF8, "application/json");

var client = new HttpClient();
var response = await client.SendAsync(request);

Console.WriteLine(await response.Content.ReadAsStringAsync());

curl -X PATCH "https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "x-api-key: sm_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Mockup Name"
  }'

{
  "data": {
    "collections": [],
    "group_layers": [],
    "height": 5000,
    "name": "Heavyweight tee front",
    "smart_objects": [
      {
        "blend_mode": "multiply",
        "layer_name": "Front print",
        "name": "Front print",
        "position": {
          "height": 3413,
          "width": 3000,
          "x": 512,
          "y": 730
        },
        "print_area_presets": [
          {
            "name": "Default",
            "position": {
              "height": 3413,
              "width": 3000,
              "x": 0,
              "y": 0
            },
            "size": {
              "height": 3413,
              "width": 3000
            },
            "thumbnails": [],
            "uuid": "d07f5b18-2c94-4e83-a6b1-95f3c8e27a40"
          }
        ],
        "quad": [
          [
            512.0,
            742.0
          ],
          [
            3512.0,
            730.0
          ],
          [
            3499.0,
            4143.0
          ],
          [
            524.0,
            4131.0
          ]
        ],
        "size": {
          "height": 3413,
          "width": 3000
        },
        "uuid": "b41a7e52-93c8-4d61-8f07-2ae5c9d04713"
      }
    ],
    "text_layers": [],
    "thumbnail": "https://cdn.sudomock.com/thumbnails/8f2c1d90_720.webp",
    "thumbnails": [
      {
        "url": "https://cdn.sudomock.com/thumbnails/8f2c1d90_720.webp",
        "width": 720
      },
      {
        "url": "https://cdn.sudomock.com/thumbnails/8f2c1d90_480.webp",
        "width": 480
      },
      {
        "url": "https://cdn.sudomock.com/thumbnails/8f2c1d90_240.webp",
        "width": 240
      }
    ],
    "uuid": "8f2c1d90-6b4e-4a37-9e55-0d1c7a3f21b8",
    "width": 4000
  },
  "message": "",
  "success": true
}

const response = await fetch("https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  method: "PATCH",
  headers: {
    "x-api-key": "sm_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Updated Mockup Name"
  }),
});

const data = await response.json();
console.log(data);

<?php

$payload = <<<'JSON'
{
  "name": "Updated Mockup Name"
}
JSON;

$ch = curl_init("https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: sm_your_api_key",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

import requests

payload = {
    "name": "Updated Mockup Name"
}

response = requests.patch(
    "https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6",
    headers={"x-api-key": "sm_your_api_key"},
    json=payload,
)

response.raise_for_status()
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6")
request = Net::HTTP::Patch.new(uri)
request["x-api-key"] = "sm_your_api_key"
request["Content-Type"] = "application/json"

request.body = <<~JSON
  {
    "name": "Updated Mockup Name"
  }
JSON

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts response.body

package main

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

func main() {
	payload := []byte(`{
  "name": "Updated Mockup Name"
}`)

	req, err := http.NewRequest("PATCH", "https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("x-api-key", "sm_your_api_key")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

String payload = """
{
  "name": "Updated Mockup Name"
}
""";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6"))
    .header("x-api-key", "sm_your_api_key")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString(payload))
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

using System.Net.Http;
using System.Text;

var payload = """
{
  "name": "Updated Mockup Name"
}
""";

var request = new HttpRequestMessage(HttpMethod.Patch, "https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6");
request.Headers.Add("x-api-key", "sm_your_api_key");
request.Content = new StringContent(payload, Encoding.UTF8, "application/json");

var client = new HttpClient();
var response = await client.SendAsync(request);

Console.WriteLine(await response.Content.ReadAsStringAsync());

curl -X PATCH "https://api.sudomock.com/api/v1/psd-mockups/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "x-api-key: sm_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Mockup Name"
  }'

{
  "data": {
    "collections": [],
    "group_layers": [],
    "height": 5000,
    "name": "Heavyweight tee front",
    "smart_objects": [
      {
        "blend_mode": "multiply",
        "layer_name": "Front print",
        "name": "Front print",
        "position": {
          "height": 3413,
          "width": 3000,
          "x": 512,
          "y": 730
        },
        "print_area_presets": [
          {
            "name": "Default",
            "position": {
              "height": 3413,
              "width": 3000,
              "x": 0,
              "y": 0
            },
            "size": {
              "height": 3413,
              "width": 3000
            },
            "thumbnails": [],
            "uuid": "d07f5b18-2c94-4e83-a6b1-95f3c8e27a40"
          }
        ],
        "quad": [
          [
            512.0,
            742.0
          ],
          [
            3512.0,
            730.0
          ],
          [
            3499.0,
            4143.0
          ],
          [
            524.0,
            4131.0
          ]
        ],
        "size": {
          "height": 3413,
          "width": 3000
        },
        "uuid": "b41a7e52-93c8-4d61-8f07-2ae5c9d04713"
      }
    ],
    "text_layers": [],
    "thumbnail": "https://cdn.sudomock.com/thumbnails/8f2c1d90_720.webp",
    "thumbnails": [
      {
        "url": "https://cdn.sudomock.com/thumbnails/8f2c1d90_720.webp",
        "width": 720
      },
      {
        "url": "https://cdn.sudomock.com/thumbnails/8f2c1d90_480.webp",
        "width": 480
      },
      {
        "url": "https://cdn.sudomock.com/thumbnails/8f2c1d90_240.webp",
        "width": 240
      }
    ],
    "uuid": "8f2c1d90-6b4e-4a37-9e55-0d1c7a3f21b8",
    "width": 4000
  },
  "message": "",
  "success": true
}

Authorizations

x-api-key

string

header

required

API key with sm_ prefix. Get your key at https://sudomock.com/dashboard/api-keys

Path Parameters

uuid

string

required

Mockup UUID

Minimum string length: 36

Body

application/json

Update request for PATCH /api/v1/psd-mockups/{uuid}

name

string | null

New mockup name

Required string length: 1 - 255

colors

MockupColour · object[] | null

The colours this mockup answers to by name. Replaces the whole list, so send every colour you want to keep. Send [] to clear it.

Maximum array length: 96

Hide child attributes

colors.label

string

required

What you call this colour, e.g. 'blue jean'. Matched exactly when a render asks for it.

Required string length: 1 - 32

colors.hex

string

required

The colour the name paints, e.g. '#6A8296'.

Pattern: ^#[0-9A-Fa-f]{6}$

Response

200 - application/json

Successful Response

The ingested mockup with every layer you can address in a render. specification

data

UploadResponseData · object

required

Response data

Hide child attributes

data.uuid

string

required

Unique identifier for the mockup

Example:

"8f2c1d90-6b4e-4a37-9e55-0d1c7a3f21b8"

data.name

string

required

Name of the mockup

Example:

"Heavyweight tee front"

data.smart_objects

SmartObjectResponse · object[]

required

List of smart objects in the PSD

Hide child attributes

data.smart_objects.uuid

string

required

Unique identifier for the smart object

Example:

"b41a7e52-93c8-4d61-8f07-2ae5c9d04713"

data.smart_objects.name

string

required

Display name of the smart object

Example:

"Front print"

data.smart_objects.size

Size · object

required

Size dimensions of the smart object

Hide child attributes

data.smart_objects.size.width

integer

required

Width in pixels

data.smart_objects.size.height

integer

required

Height in pixels

data.smart_objects.position

Position · object

required

Position coordinates (x, y, width, height)

Hide child attributes

data.smart_objects.position.x

integer

required

Position on PSD canvas in pixels (top-left origin).

data.smart_objects.position.y

integer

required

Position on PSD canvas in pixels (top-left origin).

data.smart_objects.position.width

integer

required

Width in pixels

data.smart_objects.position.height

integer

required

Height in pixels

data.smart_objects.print_area_presets

PrintAreaPreset · object[]

required

Print area preset configurations

Hide child attributes

data.smart_objects.print_area_presets.uuid

string

required

Unique identifier for the preset

Example:

"d07f5b18-2c94-4e83-a6b1-95f3c8e27a40"

data.smart_objects.print_area_presets.name

string

required

Name of the preset (e.g., 'Default')

Example:

"Default"

data.smart_objects.print_area_presets.size

Size · object

required

Size dimensions of the print area

Hide child attributes

data.smart_objects.print_area_presets.size.width

integer

required

Width in pixels

data.smart_objects.print_area_presets.size.height

integer

required

Height in pixels

data.smart_objects.print_area_presets.position

Position · object

required

Position relative to smart object (x, y, width, height)

Hide child attributes

data.smart_objects.print_area_presets.position.x

integer

required

Position on PSD canvas in pixels (top-left origin).

data.smart_objects.print_area_presets.position.y

integer

required

Position on PSD canvas in pixels (top-left origin).

data.smart_objects.print_area_presets.position.width

integer

required

Width in pixels

data.smart_objects.print_area_presets.position.height

integer

required

Height in pixels

data.smart_objects.print_area_presets.thumbnails

ThumbnailSize · object[]

Thumbnail previews of the preset

Hide child attributes

data.smart_objects.print_area_presets.thumbnails.width

integer

required

Thumbnail width in pixels

data.smart_objects.print_area_presets.thumbnails.url

string

required

Public URL to the thumbnail image

data.smart_objects.layer_name

string | null

Original PSD layer name

Example:

"Front print"

data.smart_objects.quad

number[][] | null

Four display coordinates for the editable area. Only available on Scale tier plans (null on Free/Starter/Pro).

Example:

[
  [512, 742],
  [3512, 730],
  [3499, 4143],
  [524, 4131]
]

data.smart_objects.blend_mode

string | null

The blend mode this smart object layer carries in the PSD, lowercase (e.g. 'normal', 'multiply', 'soft_light'). Null in the mockup list; request a single mockup to read it.

Example:

"multiply"

data.smart_objects.instance_count

integer | null

Number of PSD layers this input drives (smart object instancing); null/1 = single layer

Example:

3

data.thumbnail

string

default:""

Main thumbnail URL (720px width). Empty string if generation failed.

Example:

"https://cdn.sudomock.com/mockup-assets/8f2c1d90-6b4e-4a37-9e55-0d1c7a3f21b8/thumbnails/thumb_720.webp"

data.width

integer | null

Always populated after successful upload. Represents original PSD canvas width in pixels.

Example:

4000

data.height

integer | null

Always populated after successful upload. Represents original PSD canvas height in pixels.

Example:

5000

data.text_layers

TextLayer · object[]

Text layers detected in the PSD. Editable layers accept text replacement at render time.

Hide child attributes

data.text_layers.uuid

string

required

Unique identifier for the text layer

Example:

"c7d41f6a-2b58-4e93-9a10-6f83b2c5d417"

data.text_layers.name

string

required

Name of the text layer

Example:

"Brand name"

data.text_layers.text_content

string | null

Current text content of the layer

Example:

"SUMMER CLUB"

data.text_layers.font_postscript_name

string | null

PostScript name of the font used by this layer

Example:

"Montserrat-Bold"

data.text_layers.font_size

number | null

Effective font size in pixels at the PSD's native resolution

Example:

120

data.text_layers.color

string | null

Text color as hex (e.g. #FFFFFF)

Example:

"#FFFFFF"

data.text_layers.font_available

boolean | null

Whether the layer's font is available for editable rendering. When false, edits render with a default font unless a font is supplied.

data.text_layers.is_editable

boolean

default:false

Whether this layer's text can be replaced at render time

data.text_layers.segment_count

integer

default:1

Number of styled segments in this layer. 1 = single-style (edit with 'text'); 2+ = styled segments (edit with 'segments', each segment keeps its own styling)

data.text_layers.segments

TextSegment · object[] | null

The layer's styled segments, present when segment_count > 1. Override any subset by index at render time; omitted segments keep their original text.

Hide child attributes

data.text_layers.segments.index

integer

required

Stable segment position within the layer (0-based)

data.text_layers.segments.text

string

default:""

The segment's current text

data.text_layers.segments.font_postscript_name

string | null

PostScript name of the segment's font

data.text_layers.segments.font_size

number | null

Segment font size in pixels at the PSD's native resolution

data.text_layers.segments.color

string | null

Segment text color as hex (e.g. #FFFFFF)

data.text_layers.visible

boolean | null

Whether the layer is shown by default in the source file. A hidden layer can still be targeted; its text then renders. Null when unknown (older mockups).

data.text_layers.has_stroke_effect

boolean

default:false

Whether this text layer has at least one outline of its own.

data.text_layers.stroke_count

integer

default:0

Number of outlines owned by this text layer, in front-to-back stroke_color order.

data.text_layers.has_color_overlay

boolean

default:false

Whether the layer's visible color comes from a color effect. When true, a color override changes that effect's color.

data.text_layers.has_clipped_artwork

boolean | null

Whether some content in the design is clipped to this layer's letters. When true, replacing this text also re-shapes that clipped content to the new letters. Null when it could not be determined for this mockup.

data.text_layers.suggested_edit_together

string[] | null

UUIDs of other text layers that carry the same text stacked with this one, such as a fill plus an outline copy. Sending the same replacement text to all of them keeps the design consistent. Advisory only: each layer is still edited on its own by UUID, never linked automatically. Null when it could not be determined.

Example:

["a2f9c481-30d7-4b6e-8c52-1d9e7f34ab60"]

data.text_layers.enclosing_group_layers

string[] | null

UUIDs of enclosing group layers whose outlines also affect this text layer, nearest first. Advisory only: each group is edited separately through group_layers. Null when it could not be determined.

Example:

["5e8b0c72-9a41-4d36-b7f8-2c60d1e94537"]

data.group_layers

GroupLayer · object[]

Group layers whose outlines can be recolored. Changing a group outline affects everything inside that group; groups not listed keep their authored effects.

Hide child attributes

data.group_layers.uuid

string

required

Unique identifier for the group layer

Example:

"5e8b0c72-9a41-4d36-b7f8-2c60d1e94537"

data.group_layers.name

string

required

Name of the group layer

Example:

"Outlined logo"

data.group_layers.stroke_count

integer

required

Number of outlines owned by this group, in front-to-back stroke_color order

Required range: x >= 1

Example:

2

data.group_layers.has_stroke_effect

boolean

default:true

Whether the group has at least one outline of its own

data.collections

any[]

Reserved for future use. Currently always empty.

data.thumbnails

ThumbnailSize · object[]

Array of thumbnail URLs at different sizes

Hide child attributes

data.thumbnails.width

integer

required

Thumbnail width in pixels

data.thumbnails.url

string

required

Public URL to the thumbnail image

success

boolean

default:true

Success status

message

string

default:""

Optional message about the operation

warnings

UploadWarning · object[] | null

Non-fatal advisories about this upload (e.g. hidden smart object layers that are not exposed for personalization). Omitted when none.

Hide child attributes

warnings.code

string

required

Stable advisory code (PSD_HIDDEN_SMART_OBJECTS, FREE_PSD_RETENTION, PSD_LIGHT_ADJUSTMENT_UNSUPPORTED)

warnings.message

string

required

Human-readable, non-fatal advisory

⌘I

API reference

PSD mockups

Photo mockups

Fonts

Video mockups

Background removal

Studio

Webhook endpoints

Webhook deliveries

Jobs

Account

Update an existing PSD mockup

Authorizations

Path Parameters

Body

Response