App - Design Templates

Create a template

Can create a template

Endpoint

POST /api/v1/design_templates

Parameters

Name Description
design_template_category_id required Design Category ID
name required Name
description Description
purchase_url Download/Purchase URL
number_of_photos Number of photos
search_text Additional search text
primary_image_url required Primary Image URL
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

POST /api/v1/design_templates

Headers

Accept: application/json
Content-Type: application/json
App-Id: e73b09df-a18b-428b-bb1c-3d6569756642
App-Secret: 6GrHgEcNgmbPxbleoMVL1PqAExaovCLkcowmc9Xm

Body

{
  "design_template_category_id": 34,
  "name": "Autumn Leaves",
  "description": "A beautiful autumn design",
  "purchase_url": "https://example.com/gallery/123/download",
  "number_of_photos": 3,
  "search_text": "Something else",
  "primary_image_url": "https://checkcherry.com/checkcherry-logo-public.png",
  "design_category_tag_names": [
    "Autumn",
    "Thanksgiving"
  ],
  "design_category_layout_names": [
    "2x6",
    "2x4"
  ]
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 6facbf4b-d24a-440f-8ee8-071ed4d3a8dc
Content-Length: 825

Body

{
  "meta": {
    "status": "ok"
  },
  "data": {
    "id": "19",
    "type": "design_template",
    "attributes": {
      "id": 19,
      "name": "Autumn Leaves",
      "description": "A beautiful autumn design",
      "video_url": null,
      "purchase_url": "https://example.com/gallery/123/download",
      "number_of_photos": 3,
      "design_category_tag_ids": [
        18,
        19
      ],
      "design_category_tag_names": [
        "Autumn",
        "Thanksgiving"
      ],
      "design_category_layout_ids": [
        15,
        16
      ],
      "design_category_layout_names": [
        "2x6",
        "2x4"
      ],
      "primary_image": {
        "video_variant": null
      },
      "additional_images": [

      ]
    },
    "relationships": {
      "design_template_category": {
        "data": {
          "id": "34",
          "type": "design_template_category"
        }
      },
      "design_category_tags": {
        "data": [
          {
            "id": "18",
            "type": "design_category_tag"
          },
          {
            "id": "19",
            "type": "design_category_tag"
          }
        ]
      },
      "design_category_layouts": {
        "data": [
          {
            "id": "15",
            "type": "design_category_layout"
          },
          {
            "id": "16",
            "type": "design_category_layout"
          }
        ]
      }
    }
  }
}