Update Layers

// Store new entrance timing on a layer (by element id or parameter id)
await fetch("https://api.orshot.com/v1/studio/templates/12345/update-layers", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    operations: [
      {
        op: "update",
        parameter_id: "headline",
        page_id: "a1b2c3d4-5e6f-7890-abcd-ef1234567890", // or page: 1
        set: {
          transitions: { enter: { type: "slideInUp", duration: 0.6 }, showAt: 1.2 },
          style: { color: "#FFFFFF" }
        }
      }
    ]
  }),
});

// Add a logo on page 2 above the background, move a badge to the top, delete a sticker
await fetch("https://api.orshot.com/v1/studio/templates/12345/update-layers", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    operations: [
      {
        op: "add",
        page: 2, // or page_id: "b2c3d4e5-6f78-9012-bcde-f23456789012"
        element: { type: "image", content: "https://cdn.example.com/logo.png", x: 40, y: 40, width: 160, height: 60 },
        position: { above: "bg-shape" }
      },
      { op: "move", element_id: "badge", position: "top" },
      { op: "delete", element_id: "sticker-3" }
    ]
  }),
});

{
  "success": true,
  "changed": true,
  "template": {
    "id": 12345,
    "name": "Spring Sale Carousel",
    "updated_at": "2026-10-02T09:20:11.042Z",
    "pages": [
      { "page": 1, "page_id": "a1b2c3d4-...", "name": "Cover" },
      { "page": 2, "page_id": "b2c3d4e5-...", "name": "Offer" }
    ]
  },
  "results": [
    { "index": 0, "op": "add", "status": "applied", "page": 2, "page_id": "b2c3d4e5-...", "element_id": "7f6e5d4c-..." },
    { "index": 1, "op": "move", "status": "applied", "page": 2, "page_id": "b2c3d4e5-...", "element_id": "badge" },
    { "index": 2, "op": "delete", "status": "applied", "page": 2, "page_id": "b2c3d4e5-...", "element_id": "sticker-3" }
  ]
}

{
  "error": "operations[0] (update): 2 layers have parameterId \"cta\" (on pages 2, 3). Add \"page_id\" or \"page\" to pick one, or target it by element_id. Nothing was saved.",
  "code": "ambiguous_layer",
  "details": [
    { "index": 0, "op": "update", "code": "ambiguous_layer", "error": "2 layers have parameterId \"cta\" (…)" }
  ]
}