Update Option by Cluster lookup key and Option Id

PATCH 
/clusters/:lookupKey/:lookupValue/options/:optionId

Use this endpoint to update single cluster option by cluster lookup key and option id.

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about cluster lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

optionId stringrequired

The value of option id

application/json

Body

descriptions

object[]

Array [

language string

value string

]

isRequired boolean

names

object[]

Array [

language string

value string

]

shortDescriptions

object[]

Array [

language string

value string

]

source string
sourceId string

Responses

200

Update Option by Cluster lookup key and Option Id - 200

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

data

object

descriptions

object[]

Array [

language string

value string

]

id number

isRequired string

names

object[]

Array [

language string

value string

]

shortDescriptions

object[]

Array [

language string

value string

]

source string

sourceId string
messages string[]
total number

Example (from schema)

{
  "data": {
    "descriptions": [
      {
        "language": "NL",
        "value": "Muis"
      },
      {
        "language": "EN",
        "value": "Mouse"
      }
    ],
    "id": 214,
    "isRequired": "N",
    "names": [
      {
        "language": "NL",
        "value": "Muis"
      },
      {
        "language": "EN",
        "value": "Mouse"
      }
    ],
    "shortDescriptions": [
      {
        "language": "NL",
        "value": "Muis"
      },
      {
        "language": "EN",
        "value": "Mouse"
      }
    ],
    "source": "REST-API",
    "sourceId": "K72334000"
  },
  "messages": [
    "Cluster Option updated"
  ],
  "total": 1
}

Update Option by Cluster lookup key and Option Id - 200

{
  "data": {
    "descriptions": [
      {
        "language": "NL",
        "value": "Muis"
      },
      {
        "language": "EN",
        "value": "Mouse"
      }
    ],
    "id": 214,
    "isRequired": "N",
    "names": [
      {
        "language": "NL",
        "value": "Muis"
      },
      {
        "language": "EN",
        "value": "Mouse"
      }
    ],
    "shortDescriptions": [
      {
        "language": "NL",
        "value": "Muis"
      },
      {
        "language": "EN",
        "value": "Mouse"
      }
    ],
    "source": "REST-API",
    "sourceId": "K72334000"
  },
  "messages": [
    "Cluster Option updated"
  ],
  "total": 1
}

404

Update Option by Cluster lookup key and Option Id - 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": 20010,
    "messages": [
      "Cluster Option with id [216] not found for the cluster with id [213]"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20010",
    "status": 404,
    "type": "ClusterOptionNotFound"
  }
}

Update Option by Cluster lookup key and Option Id - 404

{
  "error": {
    "code": 20010,
    "messages": [
      "Cluster Option with id [216] not found for the cluster with id [213]"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20010",
    "status": 404,
    "type": "ClusterOptionNotFound"
  }
}

Loading...