Delete Company by lookup key

DELETE 
/companies/:lookupKey/:lookupValue

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

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about company lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

Responses

200

Delete Company 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": [
    "Company deleted"
  ]
}

Delete Company by lookup key - 200

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

400

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

Delete Company by lookup key - 404

{
  "error": {
    "code": 40006,
    "messages": [
      "Company with sourceId [9483] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/40006",
    "status": 404,
    "type": "CompanyNotFound"
  }
}

Loading...