Update Segment

Updates an existing segment record in the public catalog.

put

Path parameters

idstringRequired

Body

application/jsontext/jsonapplication/*+json

namestringOptional

descriptionstringOptional

Responses

200

OK

application/json

idstringOptional

namestringOptional

revisioninteger · int32Optional

descriptionstring · nullableOptional

statusstring · enumOptionalPossible values:

400

Bad Request

application/json

put

/public/v1/public-catalog/segments/{id}

HTTPcURLJavaScriptPython

PUT /public/v1/public-catalog/segments/{id} HTTP/1.1
Host: api.s1.show
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "name": "text",
  "description": "text",
  "productProfiles": [
    {
      "id": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-03-30T21:22:40.878Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-03-30T21:22:40.878Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "published": {
      "at": "2026-03-30T21:22:40.878Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "unpublished": {
      "at": "2026-03-30T21:22:40.878Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "revision": 1,
  "description": "text",
  "status": "Draft"
}