Skip to content
NimlesNimlesNimles Docs

Publish a product group

PUT
/api/tenant/{tenantId}/ProductGroups/{id}/publish
curl --request PUT \
  --url https://api.nimles.com/pim/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ProductGroups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/publish \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
tenantId
required
string format: uuid

Your tenant id.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
fields
object
key
additional properties
string
data
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
relations
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
name
string
nullable
entityId
required
string format: uuid
entityType
required
string
>= 1 characters
relationType
required
string
>= 1 characters
tenantId
string format: uuid
nullable
resourceGroupId
string format: uuid
nullable
creatorId
string format: uuid
nullable
createdDate
string format: date-time
nullable
version
integer format: int32
nullable
lastModified
string format: date-time
nullable
organizationId
string format: uuid
nullable
status
required
string
nullable
publishedDate
string format: date-time
nullable
categoryId
string format: uuid
nullable
uniqueName
string
nullable
parentId
string format: uuid
nullable
productType
required
string
nullable
tags
string
nullable
imageId
string format: uuid
nullable
logoId
string format: uuid
nullable
bannerId
string format: uuid
nullable
productPropertyIds
Array<string>
nullable
name
string
nullable
nameLocalized
object
key
additional properties
string
longName
string
nullable
longNameLocalized
object
key
additional properties
string
additionalName
string
nullable
additionalNameLocalized
object
key
additional properties
string
summary
string
nullable
summaryLocalized
object
key
additional properties
string
description
string
nullable
descriptionLocalized
object
key
additional properties
string
texts
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
value
string
nullable
valueLocalized
object
key
additional properties
string

Example generated

{
  "data": {
    "fields": {
      "additionalProperty": {
        "value": "example",
        "valueType": "example"
      }
    },
    "accessibility": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "relations": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "name": "example",
        "entityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "entityType": "example",
        "relationType": "example"
      }
    ],
    "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "creatorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "createdDate": "2026-04-15T12:00:00Z",
    "version": 1,
    "lastModified": "2026-04-15T12:00:00Z",
    "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "status": "example",
    "publishedDate": "2026-04-15T12:00:00Z",
    "categoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "uniqueName": "example",
    "parentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "productType": "example",
    "tags": "example",
    "imageId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "logoId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "bannerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "productPropertyIds": [
      "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    ],
    "name": "example",
    "nameLocalized": {
      "additionalProperty": "example"
    },
    "longName": "example",
    "longNameLocalized": {
      "additionalProperty": "example"
    },
    "additionalName": "example",
    "additionalNameLocalized": {
      "additionalProperty": "example"
    },
    "summary": "example",
    "summaryLocalized": {
      "additionalProperty": "example"
    },
    "description": "example",
    "descriptionLocalized": {
      "additionalProperty": "example"
    },
    "texts": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "value": "example",
        "valueLocalized": {
          "additionalProperty": "example"
        }
      }
    ]
  }
}

204

Section titled “204”

No Content: done, with no item to return.

401

Section titled “401”

Unauthorized: no bearer token, or one that is expired or not for this API.

403

Section titled “403”

Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.

Media typeapplication/json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Section titled “404”

Not found: no such item in the tenant.

Media typeapplication/problem+json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

409

Section titled “409”

Conflict: the item kept changing under concurrent writes; read it again and retry.

Media typeapplication/problem+json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

422

Section titled “422”

Unprocessable: the body or the change is invalid. The errors are keyed by member.

Media typeapplication/problem+json

A validation problem: the messages by member (or by JSON Pointer for a patch).

object
errors
object
key
additional properties
Array<string>
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "status": 1,
  "title": "example",
  "type": "example"
}