Creating/Updating a Group

These endpoints allow you to create new groups and modify existing ones in your organization. Groups can be used to organize users and manage permissions collectively. When creating a group, you can specify its name, add an optional description, and assign users. For existing groups, you can update any of these properties using either PUT or POST methods. Authentication via API token is required for all operations.

Creating a Group
POST /api/v1/groups/

Updating a Group
PUT /api/v1/groups/[GROUP ID]/ or POST /api/v1/groups/[GROUP ID]/

Required fields:

nameString for the name of the Group.

Optional fields:

descriptionString for the description of the Group.
usersA list of User IDs that comprise the Groups (e.g. [3, 4]).

Creating a group example

curl 'https://acmeinc.datareportive.com/api/v1/groups/' \
            -X POST \
            -H 'Authorization: Token [ TOKEN ]' \
            -H 'Content-Type: application/json' \
            -d '{"name":"My Clients", "description":"A list of my clients", "users":[1,2]}'