Skip to main content
POST
/
v2
/
group
Create Group
curl --request POST \
  --url https://api.sonderplan.com/v2/group \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Video Editors",
  "description": "Full schedule access, limited project access",
  "members": [
    {
      "id": 4,
      "first_name": "Jane",
      "last_name": "Smith",
      "primary_email": "[email protected]"
    }
  ],
  "acl_schedule": "R-",
  "acl_project": "R-",
  "acl_task": "R-",
  "acl_finance": "R-",
  "acl_report": "R-",
  "acl_contact": "R-",
  "acl_admin": "R-",
  "acl_account": "R-"
}
'
{
  "success": {
    "id": 2384
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Standard group model that returns all properties by default

​
name
string
required

Name of the group

Example:

"Video Editors"

​
description
string

Description about the group

Example:

"Full schedule access, limited project access"

​
members
Group members user model · object[]

If true, this is a system group that cannot be edited

​
acl_schedule
enum<string>

Access level to the Schedule module

Available options:
--,
R-,
RW
Example:

"R-"

​
acl_project
enum<string>

Access level to the Project module

Available options:
--,
R-,
RW
Example:

"R-"

​
acl_task
enum<string>

Access level to the Task module

Available options:
--,
R-,
RW
Example:

"R-"

​
acl_finance
enum<string>

Access level to the Finance module

Available options:
--,
R-,
RW
Example:

"R-"

​
acl_report
enum<string>

Access level to the Report module

Available options:
--,
R-,
RW
Example:

"R-"

​
acl_contact
enum<string>

Access level to the Contact module

Available options:
--,
R-,
RW
Example:

"R-"

​
acl_admin
enum<string>

Access level to the Admin module

Available options:
--,
R-,
RW
Example:

"R-"

​
acl_account
enum<string>

Access level to the Account module

Available options:
--,
R-,
RW
Example:

"R-"

Response

Successful Operation

​
success
object