PATCH Group

Please note, the Groups endpoint requires an OAuth application (i.e. approved 3rd party partners), as the end point is intended for mapping third-party application “Groups” within Rippling organizations.

Using the PUT method, all of the group fields will be updated, even if the corresponding parameter is missing. If the PATCH method is used, and a param is missing, its value won’t be changed.

PATCH /platform/api/groups/{groupId}

PATCH Group

cURL

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

import requests

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

payload = {
    "name": "GroupTest",
    "spokeId": "lkjwbfskjsdbllskdb",
    "users": [],
    "version": "yvmzhfw50hn39aas"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'GroupTest',
    spokeId: 'lkjwbfskjsdbllskdb',
    users: [],
    version: 'yvmzhfw50hn39aas'
  })
};

fetch('https://api.rippling.com/platform/api/groups/{groupId}', 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/{groupId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'GroupTest',
    'spokeId' => 'lkjwbfskjsdbllskdb',
    'users' => [
        
    ],
    'version' => 'yvmzhfw50hn39aas'
  ]),
  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/{groupId}"

	payload := strings.NewReader("{\n  \"name\": \"GroupTest\",\n  \"spokeId\": \"lkjwbfskjsdbllskdb\",\n  \"users\": [],\n  \"version\": \"yvmzhfw50hn39aas\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.rippling.com/platform/api/groups/{groupId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"GroupTest\",\n  \"spokeId\": \"lkjwbfskjsdbllskdb\",\n  \"users\": [],\n  \"version\": \"yvmzhfw50hn39aas\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"GroupTest\",\n  \"spokeId\": \"lkjwbfskjsdbllskdb\",\n  \"users\": [],\n  \"version\": \"yvmzhfw50hn39aas\"\n}"

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

200

{
  "id": "5f397f3b3ca04e478d4575ad",
  "spokeId": "lkjwbfskjsdbllskdb",
  "name": "GroupTest",
  "users": [],
  "version": "yvmzhfw50hn39aas"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

groupId · integer · required

Unique identifier for the group within Rippling.

Body

application/json

Group updates object.

This payload should be used when updating existing groups.

name · string

The name of the Group.

spokeId · string

The external identifier of the Group.

users · any[]

The array of users within the Group.

version · string

The version identifier of the Group.

Response

200 - application/json

OK

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.