Update Usergroup by lookup key
PATCH/usergroups/:lookupKey/:lookupValue
Use this endpoint to update usergroup by lookup key. If multiple usergroups with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the usergroup (e.g. source
and language
for lookup key source
).
Request
Path Parameters
Lookup key. Read more about usergroup lookup keys
The value of the key (id or sourceId)
- application/json
Body
parent
object
Responses
- 200
- 400
- 404
Update Usergroup 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 by Id - 200
Schema
data
object
parent
object
{
"data": {
"budget": "N",
"budgetInherit": "N",
"company": "",
"department": "",
"id": 213,
"inheritOrderList": "N",
"inheritProductList": "Y",
"name": "Netherlands",
"notes": "Usergroup created from API",
"office": "",
"parent": {
"id": 119
}
},
"messages": [
"Usergroup updated"
],
"total": 1
}
{
"data": {
"budget": "N",
"budgetInherit": "N",
"company": "",
"department": "",
"id": 213,
"inheritOrderList": "N",
"inheritProductList": "Y",
"name": "Netherlands",
"notes": "Usergroup created from API",
"office": "",
"parent": {
"id": 119
}
},
"messages": [
"Usergroup updated"
],
"total": 1
}
Update Usergroup 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 Usergroup 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 Usergroup byid - 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 byid - 404
Schema
error
object
{
"error": {
"code": 20006,
"messages": [
"Usergroup with id [21317] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/20006",
"status": 404,
"type": "UsergroupNotFound"
}
}
{
"error": {
"code": 20006,
"messages": [
"Usergroup with id [21317] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/20006",
"status": 404,
"type": "UsergroupNotFound"
}
}