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-"
}
'
import requests

url = "https://api.sonderplan.com/v2/group"

payload = {
"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-"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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-'
})
};

fetch('https://api.sonderplan.com/v2/group', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sonderplan.com/v2/group",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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-'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.sonderplan.com/v2/group"

payload := strings.NewReader("{\n \"name\": \"Video Editors\",\n \"description\": \"Full schedule access, limited project access\",\n \"members\": [\n {\n \"id\": 4,\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"primary_email\": \"[email protected]\"\n }\n ],\n \"acl_schedule\": \"R-\",\n \"acl_project\": \"R-\",\n \"acl_task\": \"R-\",\n \"acl_finance\": \"R-\",\n \"acl_report\": \"R-\",\n \"acl_contact\": \"R-\",\n \"acl_admin\": \"R-\",\n \"acl_account\": \"R-\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.sonderplan.com/v2/group")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Video Editors\",\n \"description\": \"Full schedule access, limited project access\",\n \"members\": [\n {\n \"id\": 4,\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"primary_email\": \"[email protected]\"\n }\n ],\n \"acl_schedule\": \"R-\",\n \"acl_project\": \"R-\",\n \"acl_task\": \"R-\",\n \"acl_finance\": \"R-\",\n \"acl_report\": \"R-\",\n \"acl_contact\": \"R-\",\n \"acl_admin\": \"R-\",\n \"acl_account\": \"R-\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.sonderplan.com/v2/group")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Video Editors\",\n \"description\": \"Full schedule access, limited project access\",\n \"members\": [\n {\n \"id\": 4,\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"primary_email\": \"[email protected]\"\n }\n ],\n \"acl_schedule\": \"R-\",\n \"acl_project\": \"R-\",\n \"acl_task\": \"R-\",\n \"acl_finance\": \"R-\",\n \"acl_report\": \"R-\",\n \"acl_contact\": \"R-\",\n \"acl_admin\": \"R-\",\n \"acl_account\": \"R-\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": {
    "id": 2384
  }
}
{
"error": {
"code": 400,
"message": "name is required... Name of the tax"
}
}

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