Create Cluster Option

POST 
/clusters/:lookupKey/:lookupValue/options

Use this endpoint to create a single cluster option. If a cluster option is successfully created, the response will include the option id.

Fields

Name	Required
names	no
descriptions	no
shortDescriptions	no
language	no
sourceId	no
source	only when sourceId is provided
isRequired	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

descriptions

object[]

Array [

language string

value string

]

isRequired boolean
language string

names

object[]

Array [

language string

value string

]

shortDescriptions

object[]

Array [

language string

value string

]

source string
sourceId string

Responses

201

Create Cluster Option - 201

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

language 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",
    "language": "NL",
    "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 created"
  ],
  "total": 1
}

Create Cluster Option - 201

{
  "data": {
    "descriptions": [
      {
        "language": "NL",
        "value": "Muis"
      },
      {
        "language": "EN",
        "value": "Mouse"
      }
    ],
    "id": 214,
    "isRequired": "N",
    "language": "NL",
    "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 created"
  ],
  "total": 1
}

404

Create Cluster Option - 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": 20007,
    "messages": [
      "Parent Cluster with id [215] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20007",
    "status": 404,
    "type": "ParentClusterNotFound"
  }
}

Create Cluster Option - 404

{
  "error": {
    "code": 20007,
    "messages": [
      "Parent Cluster with id [215] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20007",
    "status": 404,
    "type": "ParentClusterNotFound"
  }
}

Loading...