POST
/
v1
/
public
/
groups
curl --request POST \
  --url https://api.frigade.com/v1/public/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "userId": "d34daa11-3745-4ac0-880e-d4b4d51fe13f",
  "groupId": "x34daa11-3745-4ac0-880e-d4b4d51fe13f",
  "properties": {
    "name": "Acme Inc.",
    "companyUrl": "https://example.com",
    "logoUrl": "https://example.com/logo.jpg"
  },
  "events": [
    {
      "event": "SignedUp",
      "properties": {
        "source": "landing-page",
        "campaign": "summer-sale"
      }
    }
  ]
}'

This endpoint allows you to upsert new or existing Groups. If the group already exists, it will be updated with the new data. Any property left unchanged will not be modified. Changes to tracking events are append-only.

Authorizations

Authorization
string
headerrequired

Authentication header of the form Bearer: <token>, where <token> is your public or private Frigade API key

Body

application/json
userId
string

The ID of the user as defined in your own application

groupId
string
required

The ID of the group as defined in your own application

properties
object

Optional properties to add to the group

events
object[]

Optional tracking events to add to the group