Update User Address
PATCH/users/:lookupKey/:lookupValue/addresses/:addressId
Use this endpoint to update a user 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
firstNames string
lastName string
Responses
- 200
- 400
- 404
Update 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)
- Update User Address by Id - 200
Schema
data
object
firstName string
id number
lastName string
messages string[]
total number
{
"data": {
"firstName": "Miles",
"id": 81908,
"lastName": "McCoy"
},
"messages": [
"Address updated"
],
"total": 1
}
{
"data": {
"firstName": "Miles",
"id": 81908,
"lastName": "McCoy"
},
"messages": [
"Address updated"
],
"total": 1
}
Update User Address by Id - 400 (invalid schema)
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)
- Update User Address by Id - 400 (invalid schema)
Schema
error
object
code number
messages string[]
moreInfo string
status number
type string
{
"error": {
"code": 10007,
"messages": [
"#: extraneous key [firstNames] is not permitted"
],
"moreInfo": "https://www.propel.us/docs/errors/10007",
"status": 400,
"type": "SchemaValidationException"
}
}
{
"error": {
"code": 10007,
"messages": [
"#: extraneous key [firstNames] is not permitted"
],
"moreInfo": "https://www.propel.us/docs/errors/10007",
"status": 400,
"type": "SchemaValidationException"
}
}
Update User Address by Id - 404
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)
- Update User Address by Id - 404
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": 70007,
"messages": [
"Parent resource [User] with id [147601] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/70007",
"status": 404,
"type": "ParentUserNotFound"
}
}
Loading...