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

lookupKey stringrequired

Lookup key. Read more about usergroup lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

application/json

Body

budget string
budgetInherit string
company string
department string
inheritOrderList string
inheritProductList string
name string
notes string
office string

parent

object

id number

Responses

200

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

Schema

data

object

budget string

budgetInherit string

company string

department string

id number

inheritOrderList string

inheritProductList string

name string

notes string

office string

parent

object

id number
messages string[]
total number

Example (from schema)

{
  "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 - 200

{
  "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
}

400

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

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "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 by Id - 400

{
  "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"
  }
}

404

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

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 20006,
    "messages": [
      "Usergroup with id [21317] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20006",
    "status": 404,
    "type": "UsergroupNotFound"
  }
}

Update Usergroup byid - 404

{
  "error": {
    "code": 20006,
    "messages": [
      "Usergroup with id [21317] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20006",
    "status": 404,
    "type": "UsergroupNotFound"
  }
}

Loading...