Update Company Address

PATCH 
/companies/:lookupKey/:lookupValue/addresses/:addressId

Use this endpoint to update 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

application/json

Body

firstName string
lastName string
town string

Responses

200

Update 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

firstName string

id number

lastName string
messages string[]
total number

Example (from schema)

{
  "data": {
    "firstName": "Miles",
    "id": 106076,
    "lastName": "McCoy"
  },
  "messages": [
    "Address updated"
  ],
  "total": 1
}

Update Company Address - 200

{
  "data": {
    "firstName": "Miles",
    "id": 106076,
    "lastName": "McCoy"
  },
  "messages": [
    "Address updated"
  ],
  "total": 1
}

400

Update Company Address - 400 (invalid schema)

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": 10007,
    "messages": [
      "#: extraneous key [town] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Update Company Address - 400 (invalid schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#: extraneous key [town] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

404

Update Company Address - 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": 90006,
    "messages": [
      "Address with id [106276] not found for [Companies] with id [9482]"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/90006",
    "status": 404,
    "type": "AddressNotFound"
  }
}

Update Company Address - 404

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

Loading...