Zum Hauptinhalt springen

Update product

Update product

Path Parameters
productId uuid REQUIRED
Header Parameters
organization-id uuid REQUIRED

ID of organization context this request belongs to.

Request Body REQUIRED
accessDefinitionId uuid
colour string

Possible values: length ≤ 32

description string

Possible values: length ≤ 240

detailedDescription string
name string

Possible values: 3 ≤ length ≤ 50

productLinks object[]

Must be 'null' or complete list of product links. That means: a) an empty list will remove all existing links on a product b) when adding a new link, all existing links have to be also included

id uuid

Must be set only, when updating a product link

name string REQUIRED

Possible values: length ≤ 25

orderNum int32

The position for this link, within the list of product links.

url string REQUIRED

Possible values: length ≤ 2048

productStatus string

Possible values: [DRAFT, PUBLISHED]

publiclyAvailable boolean
supportMultiplePlans boolean
Responses
200

Product successfully updated

Schema OPTIONAL
accessDefinitionId uuid OPTIONAL
colour string OPTIONAL
createdAt date-time OPTIONAL
createdBy uuid OPTIONAL
description string OPTIONAL
detailedDescription string OPTIONAL
id uuid OPTIONAL
name string OPTIONAL
organization object OPTIONAL
createdAt date-time OPTIONAL
deletedAt date-time OPTIONAL
email string OPTIONAL
id uuid OPTIONAL
logo string OPTIONAL
name string OPTIONAL
provider boolean OPTIONAL
active boolean OPTIONAL
organizationId uuid OPTIONAL

Use: organization.id

organizationName string OPTIONAL

Use: organization.name

plans object[] OPTIONAL
createdAt date-time OPTIONAL
createdBy uuid OPTIONAL
deleted boolean OPTIONAL
description string OPTIONAL
id uuid OPTIONAL
name string OPTIONAL
planType string OPTIONAL

Possible values: [STATIC, DYNAMIC]

productId uuid OPTIONAL
updatedAt date-time OPTIONAL
updatedBy uuid OPTIONAL
validity object OPTIONAL
validFrom date-time OPTIONAL
validUntil date-time OPTIONAL
version string OPTIONAL
productLinks object[] OPTIONAL
id uuid OPTIONAL
name string OPTIONAL
orderNum int32 OPTIONAL
url string OPTIONAL
productStatus string OPTIONAL

Possible values: [DRAFT, PUBLISHED]

publiclyAvailable boolean OPTIONAL
supportMultiplePlans boolean OPTIONAL
400

Bad Request (e.g. element not found or resource conflict).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
403

Missing permission

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
500

Internal server error (Internal service communication or process error).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL