Skip to main content
POST
/
v1
/
public
/
groups
Adds a new property or events for a given group group
curl --request POST \
  --url https://api.frigade.com/v1/public/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groupId": "x34daa11-3745-4ac0-880e-d4b4d51fe13f",
  "userId": "d34daa11-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"
      }
    }
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://engage-docs.frigade.com/llms.txt

Use this file to discover all available pages before exploring further.

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
header
required

Authentication header of the form Bearer: <token>, where <token> is either your public or private API key. See when to use which

Body

application/json
​
groupId
string
required

The ID of the group as defined in your own application

Example:

"x34daa11-3745-4ac0-880e-d4b4d51fe13f"

​
userId
string

The ID of the user as defined in your own application

Example:

"d34daa11-3745-4ac0-880e-d4b4d51fe13f"

​
properties
object

Optional properties to add to the group

Example:
{
  "name": "Acme Inc.",
  "companyUrl": "https://example.com",
  "logoUrl": "https://example.com/logo.jpg"
}
​
events
object[]

Optional tracking events to add to the group

Example:
[
  {
    "event": "SignedUp",
    "properties": {
      "source": "landing-page",
      "campaign": "summer-sale"
    }
  }
]

Response

201

The group has been successfully created or updated