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"
  ]
}
'

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.