POST Groups

Creates a generic group, that can be associated within the third-party application.

POST /platform/api/groups

POST Groups

cURL

curl --request POST \
  --url https://api.rippling.com/platform/api/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "GroupTest4",
  "spokeId": "lkjwbfskjsdbllskdb",
  "users": [
    "5c8f7f06c592917aeee1ea9f"
  ]
}
'

import requests

url = "https://api.rippling.com/platform/api/groups"

payload = {
    "name": "GroupTest4",
    "spokeId": "lkjwbfskjsdbllskdb",
    "users": ["5c8f7f06c592917aeee1ea9f"]
}
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: 'GroupTest4',
    spokeId: 'lkjwbfskjsdbllskdb',
    users: ['5c8f7f06c592917aeee1ea9f']
  })
};

fetch('https://api.rippling.com/platform/api/groups', 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.rippling.com/platform/api/groups",
  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' => 'GroupTest4',
    'spokeId' => 'lkjwbfskjsdbllskdb',
    'users' => [
        '5c8f7f06c592917aeee1ea9f'
    ]
  ]),
  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.rippling.com/platform/api/groups"

	payload := strings.NewReader("{\n  \"name\": \"GroupTest4\",\n  \"spokeId\": \"lkjwbfskjsdbllskdb\",\n  \"users\": [\n    \"5c8f7f06c592917aeee1ea9f\"\n  ]\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.rippling.com/platform/api/groups")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"GroupTest4\",\n  \"spokeId\": \"lkjwbfskjsdbllskdb\",\n  \"users\": [\n    \"5c8f7f06c592917aeee1ea9f\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rippling.com/platform/api/groups")

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\": \"GroupTest4\",\n  \"spokeId\": \"lkjwbfskjsdbllskdb\",\n  \"users\": [\n    \"5c8f7f06c592917aeee1ea9f\"\n  ]\n}"

response = http.request(request)
puts response.read_body

201

{
  "id": "5f397f3b3ca04e478d4575ad",
  "spokeId": "lkjwbfskjsdbllskdb",
  "name": "GroupTest4",
  "users": [
    "5c8f7f06c592917aeee1ea9f"
  ],
  "version": "uu8ccavwbsb8stfn"
}

Authorizations

Authorization · string · header · required

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

Body

application/json

A group object.

name · string

User-readable name of the group.

spokeId · string

The unique ID for the group, this can be the unique identifier for the group entity object within your application.

users · string[]

An array of Rippling IDs that will be in the group.

Response

201 - application/json

Created

name · string

User-readable name of a Rippling group.

id · string

spokeId · string | null

Your id for the group; this should a unique string identifier.

version · string

The version unique identifier of the group.

users · string[]

An array of employee Rippling ids.