App - Design Templates

Update a template

Can update a template

Endpoint

PUT /api/v1/design_templates/:id

Parameters

Name Description
name Name
description Description
purchase_url Download/Purchase URL
search_text Additional search text
primary_image_url Primary Image URL
number_of_photos Number of photos
design_category_tag_ids Design Category Tag IDs
design_category_tag_names Design Category Tag Names. Automatically creates tag if not present
design_category_layout_ids Design Category Layout IDs
design_category_layout_names Design Category Layout Names. Automatically creates layout if not present

Request

Route

PUT /api/v1/design_templates/20

Headers

Accept: application/json
Content-Type: application/json
App-Id: a3429512-07d6-4400-b693-cab40fdebec3
App-Secret: VUKUB6QWKO9oJfaQ1BLyxa4gN9eN8rq0w1a9k5A9

Body

{
  "name": "Winter Celebration",
  "description": "Snowy winter celebration",
  "purchase_url": "https://example.com/gallery/123/new-download-path",
  "search_text": "New search text",
  "primary_image_url": "https://checkcherry.com/checkcherry-logo-public.png",
  "number_of_photos": 4,
  "design_category_tag_names": [
    "Autumn",
    "Winter"
  ],
  "design_category_layout_names": [
    "2x6",
    "2x6"
  ]
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c106e7e1-04b7-42dc-9536-d660ca29ace7
Content-Length: 779

Body

{
  "meta": {
    "status": "ok"
  },
  "data": {
    "id": "20",
    "type": "design_template",
    "attributes": {
      "id": 20,
      "name": "Winter Celebration",
      "description": "Snowy winter celebration",
      "video_url": null,
      "purchase_url": "https://example.com/gallery/123/new-download-path",
      "number_of_photos": 4,
      "design_category_tag_ids": [
        21,
        22
      ],
      "design_category_tag_names": [
        "Autumn",
        "Winter"
      ],
      "design_category_layout_ids": [
        17
      ],
      "design_category_layout_names": [
        "2x6"
      ],
      "primary_image": {
        "video_variant": null
      },
      "additional_images": [

      ]
    },
    "relationships": {
      "design_template_category": {
        "data": {
          "id": "35",
          "type": "design_template_category"
        }
      },
      "design_category_tags": {
        "data": [
          {
            "id": "21",
            "type": "design_category_tag"
          },
          {
            "id": "22",
            "type": "design_category_tag"
          }
        ]
      },
      "design_category_layouts": {
        "data": [
          {
            "id": "17",
            "type": "design_category_layout"
          }
        ]
      }
    }
  }
}