Update Contact by lookup key
PATCH/contacts/:lookupKey/:lookupValue
Use this endpoint to update contact by lookup key. If multiple contacts with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the contact (e.g. source
and language
for lookup key sourceId
).
Request
Path Parameters
Lookup key. Read more about contact lookup keys
The value of the key (id or sourceId)
- application/json
Body
parent
object
Responses
- 200
- 400
- 404
Update Contact 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 Contact 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": 25492,
"lastName": "McCoy",
"middleName": "",
"mobile": "0038975648",
"parent": {
"id": 9482
},
"phone": "0032445888",
"primaryLanguage": "NL",
"source": "REST-API",
"sourceId": 3002196,
"title": "Mr."
},
"messages": [
"Contact updated"
],
"total": 1
}
{
"data": {
"abbreviation": "MM",
"dateOfBirth": "28/08/1993",
"debtorId": 12345,
"email": "miles@propel.us",
"firstName": "Miles",
"gender": "M",
"id": 25492,
"lastName": "McCoy",
"middleName": "",
"mobile": "0038975648",
"parent": {
"id": 9482
},
"phone": "0032445888",
"primaryLanguage": "NL",
"source": "REST-API",
"sourceId": 3002196,
"title": "Mr."
},
"messages": [
"Contact updated"
],
"total": 1
}
Update Contact by lookup key - 400 (invalid schema)
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 Contact by lookup key - 400 (invalid schema)
Schema
error
object
{
"error": {
"code": 10007,
"messages": [
"#: extraneous key [company] is not permitted"
],
"moreInfo": "https://www.propel.us/docs/errors/10007",
"status": 400,
"type": "SchemaValidationException"
}
}
{
"error": {
"code": 10007,
"messages": [
"#: extraneous key [company] is not permitted"
],
"moreInfo": "https://www.propel.us/docs/errors/10007",
"status": 400,
"type": "SchemaValidationException"
}
}
Update Contact 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 Contact by lookup key - 404
Schema
error
object
{
"error": {
"code": 50006,
"messages": [
"Contact with id [25493] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/50006",
"status": 404,
"type": "ContactNotFound"
}
}
{
"error": {
"code": 50006,
"messages": [
"Contact with id [25493] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/50006",
"status": 404,
"type": "ContactNotFound"
}
}