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
- 404
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
- Example (from schema)
- Delete User Address by Id - 200
Schema
data
object
object
messages string[]
{
"data": {},
"messages": [
"Address deleted"
]
}
{
"data": {},
"messages": [
"Address deleted"
]
}
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
- Example (from schema)
- Delete User Address by Id - 404 (address not found)
- Delete User Address by Id - 404 (user not found)
Schema
error
object
code number
messages string[]
moreInfo string
status number
type string
{
"error": {
"code": 70007,
"messages": [
"Parent resource [User] with id [147601] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/70007",
"status": 404,
"type": "ParentUserNotFound"
}
}
{
"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"
}
}
{
"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...