Delete User Address

DELETE 
/users/:lookupKey/:lookupValue/addresses/:addressId

Use this endpoint to delete a user's address. The address is identified by id.

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about user lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

addressId stringrequired

Address id

application/json

Body

firstName string
lastName string

Responses

200

Delete User Address by Id - 200 / Delete User Address 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": [
    "Address deleted"
  ]
}

Delete User Address by Id - 200

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

404

Delete Address by Id - 404 (user not found) / Delete Address by Id - 404 (address not found) / Delete Address by Id - 404 (user not found) / Delete Address by Id - 404 (address not found)

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

Delete User Address by Id - 404 (address not found)

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

Delete User Address by Id - 404 (user not found)

{
  "error": {
    "code": 20007,
    "messages": [
      "Parent resource [Usergroup] with id [12256] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20007",
    "status": 404,
    "type": "ParentUsergroupNotFound"
  }
}

Loading...