Delete Company Address

DELETE 
/companies/:lookupKey/:lookupValue/addresses/:addressId

Use this endpoint to delete a company address. The address is identified by id.

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about company lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

addressId stringrequired

Address id

Responses

200

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

Delete Company Address - 200

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

404

Delete Company Address - 404 (company) / Delete Company Address - 404 (address)

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": 40007,
    "messages": [
      "Parent resource [Company] with id [9484] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/40007",
    "status": 404,
    "type": "ParentCompanyNotFound"
  }
}

Delete Company Address - 404 (address)

{
  "error": {
    "code": 90006,
    "messages": [
      "Address with id [106077] not found for [Companies] with id [9482]"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/90006",
    "status": 404,
    "type": "AddressNotFound"
  }
}

Delete Company Address - 404 (company)

{
  "error": {
    "code": 40007,
    "messages": [
      "Parent resource [Company] with id [9484] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/40007",
    "status": 404,
    "type": "ParentCompanyNotFound"
  }
}

Loading...