Delete Customer by lookup key

DELETE 
/customers/:lookupKey/:lookupValue

Delete a customer by a specific lookupKey / lookupId combination. A deleted customer will be moved to the Propeller Recycle bin. This means the deleted customer can be restored, however, only via the Propeller backoffice.

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about customer lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

Responses

200

Delete Customer by lookup key - 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

object
messages string[]

Example (from schema)

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

Delete Customer by lookup key - 200

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

400

Delete Customer by lookup key - 400 (invalid lookup key)

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": 10006,
    "messages": [
      "Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10006",
    "status": 400,
    "type": "InvalidLookupKey"
  }
}

Delete Customer by lookup key - 400 (invalid lookup key)

{
  "error": {
    "code": 10006,
    "messages": [
      "Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10006",
    "status": 400,
    "type": "InvalidLookupKey"
  }
}

404

Delete Customer 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": 60006,
    "messages": [
      "Customer with sourceId [25496] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/60006",
    "status": 404,
    "type": "CustomerNotFound"
  }
}

Delete Customer by lookup key - 404

{
  "error": {
    "code": 60006,
    "messages": [
      "Customer with sourceId [25496] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/60006",
    "status": 404,
    "type": "CustomerNotFound"
  }
}

Loading...