Create ProductProjectTemplate

Creates a new ProductProjectTemplate. Product project templates define default project configurations for products.

POST /api/product-project-templates

Create ProductProjectTemplate

cURL

curl --request POST \
  --url https://platform.kodexa.ai/api/product-project-templates \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "displayOrder": 123,
  "id": "<string>",
  "product": {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "id": "<string>",
    "imageUrl": "<string>",
    "name": "<string>",
    "overviewMarkdown": "<string>",
    "productGroup": {
      "active": true,
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": "<string>",
      "name": "<string>",
      "order": 123,
      "overviewMarkdown": "<string>",
      "products": "<array>",
      "searchText": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "productGroupId": "<string>",
    "searchText": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "productId": "<string>",
  "projectTemplateMetadata": {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>"
  },
  "projectTemplateMetadataId": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}
'

201

{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "displayOrder": 123,
  "id": "<string>",
  "product": {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "id": "<string>",
    "imageUrl": "<string>",
    "name": "<string>",
    "overviewMarkdown": "<string>",
    "productGroup": {
      "active": true,
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": "<string>",
      "name": "<string>",
      "order": 123,
      "overviewMarkdown": "<string>",
      "products": "<array>",
      "searchText": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "productGroupId": "<string>",
    "searchText": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "productId": "<string>",
  "projectTemplateMetadata": {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>"
  },
  "projectTemplateMetadataId": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Authorizations

x-api-keybearerAuth

x-api-key · string · header · required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Body

application/json

A product project template defines default project configurations associated with a product.

changeSequence · integer<int32>

createdOn · string<date-time>

displayOrder · integer<int32>

id · string

product · object

A product represents a purchasable offering on the Kodexa platform.

Show child attributes

productId · string | null

projectTemplateMetadata · object

Show child attributes

projectTemplateMetadataId · string | null

updatedOn · string<date-time>

uuid · string

Response

201

application/json

Created ProductProjectTemplate

A product project template defines default project configurations associated with a product.

changeSequence · integer<int32>

createdOn · string<date-time>

displayOrder · integer<int32>

id · string

product · object

A product represents a purchasable offering on the Kodexa platform.

Show child attributes

productId · string | null

projectTemplateMetadata · object

Show child attributes

projectTemplateMetadataId · string | null

updatedOn · string<date-time>

uuid · string