Legacy paths

Eleven paths still answer under their earlier names. They keep serving the same operations, on the same data, and nothing you have already shipped needs to change today. They are marked deprecated in the OpenAPI spec and left out of the reference navigation, so new code lands on the current name. Left out of the navigation, not left out of the spec: download the spec and the eleven are still in it, with deprecated: true on each, so a generated client keeps every method it has and your linter is the one that tells you which to move off.

Photo mockups

Everything under /api/v1/sudoai/2d-mockups is the same operation as its /api/v1/photo-mockups twin, on the same data.

Earlier path	Current path
`POST /api/v1/sudoai/2d-mockups`	`POST /api/v1/photo-mockups`
`GET /api/v1/sudoai/2d-mockups`	`GET /api/v1/photo-mockups`
`GET /api/v1/sudoai/2d-mockups/{mockup_id}`	`GET /api/v1/photo-mockups/{mockup_id}`
`PATCH /api/v1/sudoai/2d-mockups/{mockup_id}`	`PATCH /api/v1/photo-mockups/{mockup_id}`
`PUT /api/v1/sudoai/2d-mockups/{mockup_id}/print-areas`	`PUT /api/v1/photo-mockups/{mockup_id}/print-areas`
`POST /api/v1/sudoai/2d-mockups/{mockup_id}/render`	`POST /api/v1/photo-mockups/{mockup_id}/render`
`DELETE /api/v1/sudoai/2d-mockups/{mockup_id}`	`DELETE /api/v1/photo-mockups/{mockup_id}`

Moving is a string swap. The headers, the body and the response are identical.

The current render path

MOCKUP=9b0a74cd-0ebb-4748-a748-976fec8cc000

curl -X POST \
  "https://api.sudomock.com/api/v1/photo-mockups/$MOCKUP/render" \
  -H "x-api-key: sm_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "print_areas": [
      {
        "uuid": "223e4567-e89b-12d3-a456-426614174001",
        "artwork_url": "https://example.com/design.png"
      }
    ]
  }'

PSD mockups

Four paths under /api/v1/mockups are earlier names for the PSD mockup collection.

Earlier path	Current path
`GET /api/v1/mockups`	`GET /api/v1/psd-mockups`
`GET /api/v1/mockups/{uuid}`	`GET /api/v1/psd-mockups/{uuid}`
`PATCH /api/v1/mockups/{uuid}`	`PATCH /api/v1/psd-mockups/{uuid}`
`DELETE /api/v1/mockups/{mockup_uuid}`	`DELETE /api/v1/psd-mockups/{mockup_uuid}`

Two paths that no longer answer

The singular render paths were retired and currently return 404: the singular /api/v1/sudoai/2d-mockup/render and its older alias /api/v1/sudoai/render. The mockup id moved out of the request body and into the URL, so the body now carries only print_areas and export_options.

404 Not Found

{
  "detail": "Mockup not found",
  "success": false
}

If you see this on a path you believe is current, check that the id in the URL belongs to your account before changing anything else. See Render artwork for the shape the body takes now.

The job kind follows the path

A job accepted on /api/v1/sudoai/2d-mockups reports kind as 2d_create or 2d_render. The same job accepted on /api/v1/photo-mockups reports photo_mockup_create or photo_mockup_render. Code that compares the kind literally should accept both spellings while you move.

Accept either spelling

const CREATE_KINDS = new Set([
  "photo_mockup_create",
  "2d_create",
]);
const RENDER_KINDS = new Set([
  "photo_mockup_render",
  "2d_render",
]);

function route(job) {
  if (CREATE_KINDS.has(job.kind)) return onMockupReady(job);
  if (RENDER_KINDS.has(job.kind)) return onRenderFinished(job);
}

Webhook endpoints keep their spelling

A webhook endpoint created before the current names were introduced is pinned to the earlier spelling and keeps receiving the same five events as 2d_mockup.ready, 2d_mockup.rejected, 2d_mockup.failed, 2d_render.succeeded and 2d_render.failed. The kind inside a payload always follows the endpoint, whichever path accepted the job.

A pinned endpoint's payload

{
  "version": 1,
  "event": "2d_mockup.ready",
  "job_id": "b7f2c1a0-9e34-4d21-8f0a-1c2b3d4e5f60",
  "kind": "2d_create",
  "status": "ready",
  "mockup_id": "9b0a74cd-0ebb-4748-a748-976fec8cc000",
  "name": "Classic tee, front"
}

The endpoint object reports which spelling it receives in event_naming. New endpoints are created as current. Move an existing one once your handler reads the new names. Move an endpoint to the current names

const response = await fetch("https://api.sudomock.com/api/v1/webhook-endpoints/ENDPOINT_ID", {
  method: "PATCH",
  headers: {
    "x-api-key": "sm_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "event_naming": "current"
  }),
});

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

<?php

$payload = <<<'JSON'
{
  "event_naming": "current"
}
JSON;

$ch = curl_init("https://api.sudomock.com/api/v1/webhook-endpoints/ENDPOINT_ID");
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 = {
    "event_naming": "current"
}

response = requests.patch(
    "https://api.sudomock.com/api/v1/webhook-endpoints/ENDPOINT_ID",
    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/webhook-endpoints/ENDPOINT_ID")
request = Net::HTTP::Patch.new(uri)
request["x-api-key"] = "sm_your_api_key"
request["Content-Type"] = "application/json"

request.body = <<~JSON
  {
    "event_naming": "current"
  }
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(`{
  "event_naming": "current"
}`)

	req, err := http.NewRequest("PATCH", "https://api.sudomock.com/api/v1/webhook-endpoints/ENDPOINT_ID", 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 = """
{
  "event_naming": "current"
}
""";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.sudomock.com/api/v1/webhook-endpoints/ENDPOINT_ID"))
    .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 = """
{
  "event_naming": "current"
}
""";

var request = new HttpRequestMessage(HttpMethod.Patch, "https://api.sudomock.com/api/v1/webhook-endpoints/ENDPOINT_ID");
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/webhook-endpoints/ENDPOINT_ID" \
  -H "x-api-key: sm_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "event_naming": "current"
  }'

Change the handler before the endpoint. The switch takes effect on the next delivery, and a handler that still matches only on 2d_render.succeeded will stop recognising its own renders.

Photo mockups

The current two step flow, end to end.

Webhooks

Event names, payloads and signature verification.

Overview

PSD mockups

Photo mockups

Text and fonts

Integrations

Reference

Advanced

Changes

Photo mockups

PSD mockups

Two paths that no longer answer

The job kind follows the path

Webhook endpoints keep their spelling

Next

Photo mockups

Webhooks

​Photo mockups

​PSD mockups

​Two paths that no longer answer

​The job kind follows the path

​Webhook endpoints keep their spelling

​Next

Photo mockups

Webhooks

Photo mockups

PSD mockups

Two paths that no longer answer

The job kind follows the path

Webhook endpoints keep their spelling

Next