Update Customer by lookup key
PATCH/customers/:lookupKey/:lookupValue
Use this endpoint to update customer by lookup key. If multiple customers with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the customer (e.g. source
and language
for lookup key source
).
Request
Path Parameters
Lookup key. Read more about customer lookup keys
The value of the key (id or sourceId)
- application/json
Body
parent
object
Responses
- 200
- 400
- 404
Update Customer by lookup key - 200
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Update Customer by lookup key - 200
Schema
data
object
parent
object
{
"data": {
"abbreviation": "MM",
"dateOfBirth": "28/08/1993",
"debtorId": 12345,
"email": "miles@propel.us",
"firstName": "Miles",
"gender": "M",
"id": 25494,
"lastName": "McCoy",
"middleName": "",
"mobile": "0038975648",
"parent": {
"id": 109
},
"phone": "0032445888",
"primaryLanguage": "NL",
"source": "REST-API",
"sourceId": 3002196,
"title": "Mr."
},
"messages": [
"Customer updated"
],
"total": 1
}
{
"data": {
"abbreviation": "MM",
"dateOfBirth": "28/08/1993",
"debtorId": 12345,
"email": "miles@propel.us",
"firstName": "Miles",
"gender": "M",
"id": 25494,
"lastName": "McCoy",
"middleName": "",
"mobile": "0038975648",
"parent": {
"id": 109
},
"phone": "0032445888",
"primaryLanguage": "NL",
"source": "REST-API",
"sourceId": 3002196,
"title": "Mr."
},
"messages": [
"Customer updated"
],
"total": 1
}
Update Customer by lookup key - 400 (invalid lookup key)
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Update Customer by lookup key - 400 (invalid lookup key)
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 Customer by lookup key - 404
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Update Customer by lookup key - 404
Schema
error
object
{
"error": {
"code": 60006,
"messages": [
"Customer with id [25496] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/60006",
"status": 404,
"type": "CustomerNotFound"
}
}
{
"error": {
"code": 60006,
"messages": [
"Customer with id [25496] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/60006",
"status": 404,
"type": "CustomerNotFound"
}
}