POST /api/usergroups
Create a user group

Examples

POST /api/usergroups
{
  "usergroup": {
    "name": "usergroup69"
  }
}
422
{
  "error": {
    "id": null,
    "errors": {
      "name": [
        "has already been taken"
      ]
    },
    "full_messages": [
      "Name has already been taken"
    ]
  }
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
usergroup
required

Validations:

  • Must be a Hash
usergroup[name]
required

Validations:

  • Must be a String
usergroup[admin]
optional , nil allowed

is an admin user group, can be modified by admins only

Validations:

  • Must be one of: true, false, 1, 0.
usergroup[user_ids]
optional , nil allowed

Validations:

  • Must be an array of any type
usergroup[usergroup_ids]
optional , nil allowed

Validations:

  • Must be an array of any type
usergroup[role_ids]
optional , nil allowed

Validations:

  • Must be an array of any type