Delete Category by lookup key

DELETE 
/categories/:lookupKey/:lookupValue

Use this endpoint to delete category by lookup key. If multiple categories with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the category (e.g. source and language for lookup key source).

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about category lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

Query Parameters

source string

Optional. Used in combination with lookup key sourceId

language string

Optional. Default language of the category

Responses

200

Delete Category by Id - 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": [
    "Category deleted"
  ]
}

Delete Category by Id - 200

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

404

Delete Category by Id - 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": 30006,
    "messages": [
      "Category with sourceId [2947] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/30006",
    "status": 404,
    "type": "CategoryNotFound"
  }
}

Delete Category by Id - 404

{
  "error": {
    "code": 30006,
    "messages": [
      "Category with sourceId [2947] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/30006",
    "status": 404,
    "type": "CategoryNotFound"
  }
}

Loading...