Update Pages

// Append a page (no existing page changes number)
await fetch("https://api.orshot.com/v1/studio/templates/12345/update-pages", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    base_updated_at: "2026-10-02T09:12:44.120Z", // from GET /v1/studio/templates/12345
    operations: [
      {
        op: "add",
        page_data: {
          name: "Pricing",
          canvas: { width: 1080, height: 1080, backgroundColor: "#0F172A" },
          elements: [
            { type: "text", content: "Plans from $9", x: 80, y: 120, width: 920, height: 120, parameterizable: true, parameterId: "price_line" }
          ]
        }
      }
    ]
  }),
});

// Rename page 2 and change its background; canvas merges, so width/height stay
await fetch("https://api.orshot.com/v1/studio/templates/12345/update-pages", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    operations: [
      // By page id (stays valid after pages are reordered). By number: { op: "update", page: 2, set: { ... } }
      { op: "update", page_id: "b2c3d4e5-6f78-9012-bcde-f23456789012", set: { name: "Offer", canvas: { backgroundColor: "#FFFFFF" } } }
    ]
  }),
});

// Copy the cover to the end, then move it to the front.
// Moving changes existing page numbers, so allow_reindex is required.
await fetch("https://api.orshot.com/v1/studio/templates/12345/update-pages", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    allow_reindex: true,
    operations: [
      { op: "duplicate", page: 1 }, // or page_id: "a1b2c3d4-..."
      { op: "move", page: 4, position: 1 } // the copy is page 4 at this point; its page_id is in the response
    ]
  }),
});

{
  "success": true,
  "changed": true,
  "template": {
    "id": 12345,
    "name": "Spring Sale Carousel",
    "updated_at": "2026-10-02T09:14:03.511Z",
    "pages": [
      { "page": 1, "page_id": "f0e1d2c3-...", "name": "Cover" },
      { "page": 2, "page_id": "a1b2c3d4-...", "name": "Cover" },
      { "page": 3, "page_id": "b2c3d4e5-...", "name": "Offer" },
      { "page": 4, "page_id": "c3d4e5f6-...", "name": "Back" }
    ]
  },
  "results": [
    { "index": 0, "op": "duplicate", "status": "applied", "page_id": "f0e1d2c3-...", "source_page_id": "a1b2c3d4-...", "page": 1 },
    { "index": 1, "op": "move", "status": "applied", "page_id": "f0e1d2c3-...", "page": 1 }
  ],
  "reindexed": [
    { "page_id": "a1b2c3d4-...", "from": 1, "to": 2 },
    { "page_id": "b2c3d4e5-...", "from": 2, "to": 3 },
    { "page_id": "c3d4e5f6-...", "from": 3, "to": 4 }
  ]
}

{
  "error": "These operations change the numbers of existing pages (page 1 → 2, page 2 → 3, page 3 → 4). Render calls that address pages by number (\"page2@headline\", includePages) would then hit different pages. Send \"allow_reindex\": true to confirm, or add/duplicate pages at the end instead. Nothing was saved.",
  "code": "reindex_not_allowed",
  "details": [
    { "index": null, "code": "reindex_not_allowed", "error": "These operations change the numbers of existing pages (…)" }
  ]
}