Create Overlay

POST 
/v1/product/:product_id/overlay

Create a new overlay

Request

Path Parameters

product_id uuidrequired

The product ID

application/json

Body

required

name Name (string)

Name of the overlay

description Description (string)

Description of the overlay

overlay_id uuid

Unique identifier for the overlay

Responses

201

Successful Response

application/json

Schema

Schema

last_modified_account_id uuid

Account ID of the user who last modified the resource

last_modified_timestamp date-time

Timestamp of when the resource was last modified

created_timestamp date-time

Timestamp of when this resource was created

name Name (string)

Name of the overlay

description Description (string)

Description of the overlay

overlay_id uuidrequired

Unique identifier for the overlay

Example (from schema)

{
  "last_modified_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "last_modified_timestamp": "2024-07-29T15:51:28.071Z",
  "created_timestamp": "2024-07-29T15:51:28.071Z",
  "name": "string",
  "description": "string",
  "overlay_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...