Update User by lookup key
PATCH/users/:lookupKey/:lookupValue
Use this endpoint to update user by lookup key. If multiple users with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the user (e.g. source
and language
for lookup key source
).
Request
Path Parameters
Lookup key. Read more about user lookup keys
The value of the key (id or sourceId)
- application/json
Body
parent
object
Responses
- 200
- 400
- 404
Update User 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 by Id - 200
Schema
data
object
parent
object
{
"data": {
"abbreviation": "MM",
"dateOfBirth": "28/08/1993",
"debtorId": 12345,
"email": "miles@propel.us",
"firstName": "Miles",
"gender": "M",
"id": 14760,
"lastName": "McCoy",
"login": "miles@propel.us",
"middleName": "",
"mobile": "0038975648",
"parent": {
"id": 119
},
"phone": "0032445888",
"source": "REST-API",
"sourceId": 3002196,
"title": "Mr."
},
"messages": [
"User updated"
],
"total": 1
}
{
"data": {
"abbreviation": "MM",
"dateOfBirth": "28/08/1993",
"debtorId": 12345,
"email": "miles@propel.us",
"firstName": "Miles",
"gender": "M",
"id": 14760,
"lastName": "McCoy",
"login": "miles@propel.us",
"middleName": "",
"mobile": "0038975648",
"parent": {
"id": 119
},
"phone": "0032445888",
"source": "REST-API",
"sourceId": 3002196,
"title": "Mr."
},
"messages": [
"User updated"
],
"total": 1
}
Update User by Id - 400
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 by Id - 400
Schema
error
object
{
"error": {
"code": 10006,
"messages": [
"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId]"
],
"moreInfo": "https://www.propel.us/docs/errors/10006",
"status": 400,
"type": "InvalidLookupKey"
}
}
{
"error": {
"code": 10006,
"messages": [
"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId]"
],
"moreInfo": "https://www.propel.us/docs/errors/10006",
"status": 400,
"type": "InvalidLookupKey"
}
}
Update User 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 by Id - 404
Schema
error
object
{
"error": {
"code": 70006,
"messages": [
"User with id [1476036] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/70006",
"status": 404,
"type": "UserNotFound"
}
}
{
"error": {
"code": 70006,
"messages": [
"User with id [1476036] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/70006",
"status": 404,
"type": "UserNotFound"
}
}