Delete attribute by lookup key

DELETE 
/attributes/:lookupKey/:lookupValue

This endpoint is used to delete an attribute. The attribute is identified by it's Propeller Id or name. The attributeClass Query Param is useful to use when the same attribute name is used for an attribute with a different class.

When an attribute is deleted all the values set on resources (products, users, etc.) will be deleted as well.

Request

Path Parameters

lookupKey stringrequired

Lookup key. Use id or name

lookupValue stringrequired

The id or name of the attribute

Query Parameters

attributeClass string

Attribute class. Optional. Used in combination with lookup key name. Possible values are product, category, user

Responses

200

Delete attribute by Id - 200 / Delete attribute by name and class - 200

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

data

object

object
messages string[]

Example (from schema)

{
  "data": {},
  "messages": [
    "Attribute deleted"
  ]
}

Delete attribute by Id - 200

{
  "data": {},
  "messages": [
    "Attribute deleted"
  ]
}

Delete attribute by name and class - 200

{
  "data": {},
  "messages": [
    "Attribute deleted"
  ]
}

404

Delete attribute by Id - 404 / Delete attribute by name and class - 404

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  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": 14001,
    "messages": [
      "Attribute with id [85] not found."
    ],
    "moreInfo": "https://www.propel.us/docs/errors/14001",
    "status": 404,
    "type": "AttributeNotFound"
  }
}

Delete attribute by Id - 404

{
  "error": {
    "code": 14001,
    "messages": [
      "Attribute with id [85] not found."
    ],
    "moreInfo": "https://www.propel.us/docs/errors/14001",
    "status": 404,
    "type": "AttributeNotFound"
  }
}

Delete attribute by name and class - 404

{
  "error": {
    "code": 14001,
    "messages": [
      "Attribute with name [COLOR] and attributeClass [product] not found."
    ],
    "moreInfo": "https://www.propel.us/docs/errors/14001",
    "status": 404,
    "type": "AttributeNotFound"
  }
}

Loading...