Update Usergroup Address
PATCH/usergroups/:lookupKey/:lookupValue/addresses/:addressId
Use this endpoint to update a usergroup address. The address is identified by id
.
Request
Path Parameters
Lookup key. Read more about usergroup lookup keys
The value of the key (id or sourceId)
Address id
- application/json
Body
Responses
- 200
- 400
- 404
Update Usergroup 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 Usergroup Address by Id - 200
Schema
data
object
{
"data": {
"firstName": "Miles",
"id": 81918,
"lastName": "McCoy"
},
"messages": [
"Address updated"
],
"total": 1
}
{
"data": {
"firstName": "Miles",
"id": 81918,
"lastName": "McCoy"
},
"messages": [
"Address updated"
],
"total": 1
}
Update Usergroup 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 Usergroup Address by Id - 400 (invalid schema)
Schema
error
object
{
"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 Usergroup 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 Usergroup Address by Id - 404
Schema
error
object
{
"error": {
"code": 20007,
"messages": [
"Parent resource [Usergroup] with id [12256] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/20007",
"status": 404,
"type": "ParentUsergroupNotFound"
}
}
{
"error": {
"code": 20007,
"messages": [
"Parent resource [Usergroup] with id [12256] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/20007",
"status": 404,
"type": "ParentUsergroupNotFound"
}
}