Skip to main content
PUT
/
platform
/
api
/
groups
/
{groupId}
PUT Group
curl --request PUT \
  --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": "uu8ccavwbsb8stfn"
}'
{
  "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.