Update Cluster by lookup key

PATCH 
/clusters/:lookupKey/:lookupValue

Use this endpoint to update a single cluster.

Fields

Name	Required
names	no
descriptions	no
shortDescriptions	no
language	no
parent	no
sourceId	no
source	only when sourceId is provided
clusterConfigId	no
code	no

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about cluster lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

application/json

Body

clusterConfigId number
code string

descriptions

object[]

Array [

language string

value string

]

names

object[]

Array [

language string

value string

]

parent

object

id number

shortDescriptions

object[]

Array [

language string

value string

]

source string
sourceId string

Responses

200

Update Cluster by lookup key - 200

Response Headers

• Alt-Svc

  string

• Content-Length

  string

• Via

  string

• alt-svc

  string

• date

  string

• return-format

  string

• x-request-id

  string

application/json

Schema

Schema

data

object

clusterConfigId number

code string

descriptions

object[]

Array [

language string

value string

]

id number

names

object[]

Array [

language string

value string

]

parent

object

id number

shortDescriptions

object[]

Array [

language string

value string

]

source string

sourceId string
messages string[]
total number

Example (from schema)

{
  "data": {
    "clusterConfigId": 11,
    "code": "151203000",
    "descriptions": [
      {
        "language": "NL",
        "value": "Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."
      },
      {
        "language": "EN",
        "value": "Ballpoint pens with ViscoGlide technology. Combines the advantages of a ballpoint pen and a gel pen. Available in medium (1mm.) and XB (1.4mm.) point."
      }
    ],
    "id": 210,
    "names": [
      {
        "language": "NL",
        "value": "Balpen Slider XB extra"
      },
      {
        "language": "EN",
        "value": "Pen Slider XB extra"
      }
    ],
    "parent": {
      "id": 23409
    },
    "shortDescriptions": [
      {
        "language": "NL",
        "value": "Balpen Slider XB extra"
      },
      {
        "language": "EN",
        "value": "Pen Slider XB extra"
      }
    ],
    "source": "REST-API",
    "sourceId": "151203000"
  },
  "messages": [
    "Cluster updated"
  ],
  "total": 1
}

Update Cluster by lookup key - 200

{
  "data": {
    "clusterConfigId": 11,
    "code": "151203000",
    "descriptions": [
      {
        "language": "NL",
        "value": "Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."
      },
      {
        "language": "EN",
        "value": "Ballpoint pens with ViscoGlide technology. Combines the advantages of a ballpoint pen and a gel pen. Available in medium (1mm.) and XB (1.4mm.) point."
      }
    ],
    "id": 210,
    "names": [
      {
        "language": "NL",
        "value": "Balpen Slider XB extra"
      },
      {
        "language": "EN",
        "value": "Pen Slider XB extra"
      }
    ],
    "parent": {
      "id": 23409
    },
    "shortDescriptions": [
      {
        "language": "NL",
        "value": "Balpen Slider XB extra"
      },
      {
        "language": "EN",
        "value": "Pen Slider XB extra"
      }
    ],
    "source": "REST-API",
    "sourceId": "151203000"
  },
  "messages": [
    "Cluster updated"
  ],
  "total": 1
}

404

Update Cluster by lookup key - 404

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 20006,
    "messages": [
      "Cluster with id [211] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20006",
    "status": 404,
    "type": "ClusterNotFound"
  }
}

Update Cluster by lookup key - 404

{
  "error": {
    "code": 20006,
    "messages": [
      "Cluster with id [211] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20006",
    "status": 404,
    "type": "ClusterNotFound"
  }
}

Loading...