Create Usergroup
POST/usergroups/
Use this endpoint to create a single usergroup. If a usergroup is successfully created, the response will include the usergroup id
.
Fields
Name | Required |
---|---|
name | no |
language | no |
parent | no |
company | no |
department | no |
office | no |
notes | no |
inheritProductList | no Default is Y |
inheritOrderList | no Default is Y |
budget | no Default is N |
budgetInherit | no Default is Y |
orderListAllowAll | no Default is U |
sourceId | no |
source | only when sourceId is provided |
Request
- application/json
Body
budget string
budgetInherit string
company string
department string
inheritOrderList string
inheritProductList string
language string
name string
notes string
office string
parent
object
id number
Responses
- 201
- 400
Create Usergroup - 201
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)
- Create Usergroup - 201
Schema
data
object
budget string
budgetInherit string
company string
department string
id number
inheritOrderList string
inheritProductList string
language string
name string
notes string
office string
parent
object
id number
messages string[]
total number
{
"data": {
"budget": "N",
"budgetInherit": "N",
"company": "",
"department": "",
"id": 213,
"inheritOrderList": "N",
"inheritProductList": "Y",
"language": "NL",
"name": "Netherlands",
"notes": "Usergroup created from API",
"office": "",
"parent": {
"id": 119
}
},
"messages": [
"Usergroup created"
],
"total": 1
}
{
"data": {
"budget": "N",
"budgetInherit": "N",
"company": "",
"department": "",
"id": 213,
"inheritOrderList": "N",
"inheritProductList": "Y",
"language": "NL",
"name": "Netherlands",
"notes": "Usergroup created from API",
"office": "",
"parent": {
"id": 119
}
},
"messages": [
"Usergroup created"
],
"total": 1
}
Create Usergroup - 400 (invalid payload)
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)
- Create Usergroup - 400 (invalid payload)
Schema
error
object
code number
messages string[]
moreInfo string
status number
type string
{
"error": {
"code": 10005,
"messages": [
"Invalid JSON Payload"
],
"moreInfo": "https://www.propel.us/docs/errors/10005",
"status": 400,
"type": "InvalidJSONPayload"
}
}
{
"error": {
"code": 10005,
"messages": [
"Invalid JSON Payload"
],
"moreInfo": "https://www.propel.us/docs/errors/10005",
"status": 400,
"type": "InvalidJSONPayload"
}
}
Loading...